パッケージmx.graphics
クラスpublic dynamic class ImageSnapshot
継承ImageSnapshot Inheritance Object

Flex UIComponent など、flash.display.IBitmapDrawable を実装する Flash コンポーネントのスナップショットをキャプチャするのに使用するヘルパークラスです。

このクラスのインスタンスは、クライアント側イメージの PDF ファイルを生成するために、RemoteObject を介して Adobe の LiveCycle Data Services に送信できます。 contentType、width、および height 以外の、イメージの追加プロパティを指定する必要がある場合、properties オブジェクトに名前と値のペアを設定する必要があります。

Flex の以前のバージョンでは、これらの追加プロパティは ImageSnapshot インスタンス自体に設定していました。 設定を可能にするために、このクラスは動的でしたが、Flex の今後のバージョンでは、このクラスは動的ではありません。


パブリックプロパティ
 プロパティ定義元
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  contentType : String
このスナップショットをキャプチャするために使用されたイメージエンコード形式の MIME コンテンツタイプです。
ImageSnapshot
  data : ByteArray
イメージスナップショットを表すエンコードされたデータです。
ImageSnapshot
  defaultEncoder : Class
[静的] イメージをキャプチャするために使用される、デフォルトの mx.graphics.codec.IImageEncoder 実装です。
ImageSnapshot
  height : int
ピクセル単位で表したイメージの高さです。
ImageSnapshot
  properties : Object
イメージの追加プロパティを指定する名前と値のペアを含む Object です。
ImageSnapshot
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  width : int
ピクセル単位で表したイメージの幅です。
ImageSnapshot
パブリックメソッド
 メソッド定義元
  
ImageSnapshot(width:int = 0, height:int = 0, data:ByteArray = null, contentType:String = null)
コンストラクタです。
ImageSnapshot
  
captureBitmapData(source:IBitmapDrawable, matrix:Matrix = null, colorTransform:ColorTransform = null, blendMode:String = null, clipRect:Rectangle = null, smoothing:Boolean = false):BitmapData
[静的] BitmapData として UI コンポーネントの生のスナップショットを取得するユーティリティメソッドです。
ImageSnapshot
  
captureImage(source:IBitmapDrawable, dpi:Number = 0, encoder:IImageEncoder = null, scaleLimited:Boolean = true):ImageSnapshot
[静的] コンポーネントのスナップショットを取得し、それを特定の解像度（dpi 単位）に拡大 / 縮小し、特定のイメージ形式にエンコードするユーティリティメソッドです。
ImageSnapshot
  
encodeImageAsBase64(snapshot:ImageSnapshot):String
[静的] ImageSnapshot を Base-64 でエンコードされたストリングに変換するユーティリティメソッドです。このストリングは、XML などのテキストベースの直列化形式で転送できます。
ImageSnapshot
 Inherited
hasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
toString():String
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
valueOf():Object
指定されたオブジェクトのプリミティブな値を返します。
Object
パブリック定数
 定数定義元
  MAX_BITMAP_DIMENSION : int = 2880
[静的] Bitmap の最大の幅および高さです。
ImageSnapshot
プロパティの詳細
contentTypeプロパティ
contentType:String

このスナップショットをキャプチャするために使用されたイメージエンコード形式の MIME コンテンツタイプです。 PNG 形式のイメージの場合、MIME タイプは "image/png" です。 JPG イメージまたは JPEG イメージの場合、MIME タイプは "image/jpeg" です。



実装
    public function get contentType():String
    public function set contentType(value:String):void
dataプロパティ 
data:ByteArray

イメージスナップショットを表すエンコードされたデータです。



実装
    public function get data():ByteArray
    public function set data(value:ByteArray):void
defaultEncoderプロパティ 
public static var defaultEncoder:Class

イメージをキャプチャするために使用される、デフォルトの mx.graphics.codec.IImageEncoder 実装です。 実装は PNGEncoder と JPEGEncoder の 2 つがあります。 デフォルトのエンコーダでは、PNG 形式が使用されます。

heightプロパティ 
height:int

ピクセル単位で表したイメージの高さです。



実装
    public function get height():int
    public function set height(value:int):void
propertiesプロパティ 
properties:Object

イメージの追加プロパティを指定する名前と値のペアを含む Object です。

通常、PDF ファイルを生成するために ImageSnapshot インスタンスを Adobe の LiveCycle Data Services に送信する場合に限り、このような情報を指定します。 既存の空の Object に対してオブジェクト全体を設定すること、または個々の名前と値のペアを設定することができます。

デフォルト値 : {}.



実装
    public function get properties():Object
    public function set properties(value:Object):void
widthプロパティ 
width:int

ピクセル単位で表したイメージの幅です。



実装
    public function get width():int
    public function set width(value:int):void
コンストラクタの詳細
ImageSnapshot()コンストラクタ
public function ImageSnapshot(width:int = 0, height:int = 0, data:ByteArray = null, contentType:String = null)

コンストラクタです。

パラメータ
width:int (default = 0) — イメージの幅です。
 
height:int (default = 0) — イメージの高さです。
 
data:ByteArray (default = null) — イメージを含むバイト配列です。
 
contentType:String (default = null) — イメージのエンコーダのタイプ（PNGEncoder または JPEGEncoder）です。
メソッドの詳細
captureBitmapData()メソッド
public static function captureBitmapData(source:IBitmapDrawable, matrix:Matrix = null, colorTransform:ColorTransform = null, blendMode:String = null, clipRect:Rectangle = null, smoothing:Boolean = false):BitmapData

BitmapData として UI コンポーネントの生のスナップショットを取得するユーティリティメソッドです。

パラメータ

source:IBitmapDrawable — flash.display.IBitmapDrawable インターフェイスを実装するオブジェクトです。
 
matrix:Matrix (default = null) — キャプチャしたビットマップの座標を拡大 / 縮小、回転、または変換するために使用される Matrix オブジェクトです。 マトリックス変換をイメージに適用したくない場合は、（デフォルトの new Matrix() コンストラクタを使用して作成される）単位マトリックスにこのパラメータを設定するか、null 値を渡してください。
 
colorTransform:ColorTransform (default = null) — ビットマップのカラー値を調整するために使用する ColorTransform オブジェクトです。オブジェクトが提供されない場合、ビットマップイメージのカラーは変換されません。このパラメータを渡す必要があるが、イメージを変換したくない場合、このパラメータを、デフォルトの new ColorTransform() コンストラクタを使って作成される ColorTransform オブジェクトに設定します。
 
blendMode:String (default = null) — 結果として生成されるビットマップに適用されるブレンドモードを指定する、flash.display.BlendMode クラスのストリング値です。
 
clipRect:Rectangle (default = null) — 描画するソースオブジェクトの領域を定義する矩形オブジェクトです。この値を指定しない場合、クリッピングは発生せず、ソースオブジェクト全体が描画されます。
 
smoothing:Boolean (default = false) — 拡大および縮小時に BitmapData オブジェクトのスムージングを行うかどうかを決定するブール値です。

戻り値
BitmapData — キャプチャしたスナップショットを表す BitmapData オブジェクトです。
captureImage()メソッド 
public static function captureImage(source:IBitmapDrawable, dpi:Number = 0, encoder:IImageEncoder = null, scaleLimited:Boolean = true):ImageSnapshot

コンポーネントのスナップショットを取得し、それを特定の解像度（dpi 単位）に拡大 / 縮小し、特定のイメージ形式にエンコードするユーティリティメソッドです。

パラメータ

source:IBitmapDrawable — flash.display.IBitmapDrawable インターフェイスを実装するオブジェクトです。
 
dpi:Number (default = 0) — dpi（1 インチあたりのドット数）単位の解像度です。 解像度を指定しない場合、デフォルトでは現在の画面の解像度が使用されます。
 
encoder:IImageEncoder (default = null) — 生のビットマップをエンコードするのに使用されるイメージ形式です。 エンコーダは PNGEncoder と JPEGEncoder の 2 つがあります。 エンコーダを指定しない場合、デフォルトは PNGEncoder です。
 
scaleLimited:Boolean (default = true) — Flash におけるビットマップの最大の幅および高さは 2880 ピクセルです。scaleLimited を true に設定した場合、解像度は 2880 ピクセル以内に収まるように比率を保ちながら縮小されます。scaleLimited を false に設定した場合、小さいスナップショットウィンドウが使用され、大きいイメージをキャプチャするために、それらが結合されます。 デフォルトは true です。

戻り値
ImageSnapshot — キャプチャされエンコードされたスナップショットと関連するイメージメタデータを格納する ImageSnapshot です。
encodeImageAsBase64()メソッド 
public static function encodeImageAsBase64(snapshot:ImageSnapshot):String

ImageSnapshot を Base-64 でエンコードされたストリングに変換するユーティリティメソッドです。このストリングは、XML などのテキストベースの直列化形式で転送できます。

パラメータ

snapshot:ImageSnapshot — mx.graphics.ImageSnapshot としてキャプチャされたイメージです。

戻り値
String — base64 でエンコードされたスナップショットを表す文字列です。

関連項目

captureImage
定数の詳細
MAX_BITMAP_DIMENSION定数
public static const MAX_BITMAP_DIMENSION:int = 2880

Bitmap の最大の幅および高さです。




© 2009 Adobe Systems Incorporated. All rights reserved.
Thu Mar 19 2009, 08:51 PM -07:00
 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/graphics/ImageSnapshot.html