BitmapUtil - Adobe ActionScript® 3 (AS3 Flex) API Reference

Package	spark.utils
Class	public class BitmapUtil
Inheritance	BitmapUtil Object

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

This class provides bitmap-related utility functions

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		getSnapshot(target:IUIComponent, visibleBounds:Rectangle = null, propagateColorTransform:Boolean = false):BitmapData [static] Creates a BitmapData representation of the target object.	BitmapUtil
		getSnapshotWithPadding(target:IUIComponent, padding:int = 4, propagateColorTransform:Boolean = false, bounds:Rectangle = null):BitmapData [static] Creates a BitmapData representation of the target object.	BitmapUtil
		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

Method Detail

getSnapshot

()

method

 public static function getSnapshot(target:IUIComponent, visibleBounds:Rectangle = null, propagateColorTransform:Boolean = false):BitmapData

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Creates a BitmapData representation of the target object.

Parameters

	`target:IUIComponent` — The object to capture in the resulting BitmapData

	`visibleBounds:Rectangle` (default = `null`) — If non-null, this Rectangle will be populated with the visible bounds of the object, relative to the object itself.

	`propagateColorTransform:Boolean` (default = `false`) — If true, the target's color transform will be applied to the bitmap capture operation.

Returns

BitmapData — A BitmapData object containing the image.

Throws

SecurityError — The target object and 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.

getSnapshotWithPadding

()

method

 public static function getSnapshotWithPadding(target:IUIComponent, padding:int = 4, propagateColorTransform:Boolean = false, bounds:Rectangle = null):BitmapData

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Creates a BitmapData representation of the target object.

Parameters

	`target:IUIComponent` — The object to capture in the resulting BitmapData

	`padding:int` (default = `4`) — Padding, in pixels, around to target to be included in the bitmap.

	`propagateColorTransform:Boolean` (default = `false`) — If true, the target's color transform will be applied to the bitmap capture operation.

	`bounds:Rectangle` (default = `null`) — If non-null, this Rectangle will be populated with the visible bounds of the object, relative to the object itself.

Returns

BitmapData — A BitmapData object containing the image.

Throws

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

BitmapUtil - AS3 Flex

Classes x

getSnapshot

getSnapshotWithPadding