The FileReference which handles the file operations.

Get or set the maximum allowed image size.

The size of the exported image will not exceed the size defined by this property.

Note that earlier Flash Player versions have limited bitmap sizes. For Flash Player 9 and earlier the maximum size should not be larger than 2880x2880. Flash Player 10 allows a maximum width or height of 8191 pixels and a total number of 16,777,215 pixels. Since Flash Player 11 there is no size limit.

See also

Creates a new FileReference and sets the fileReference property.

This method registers all event listeners to the appropriate callbacks and thus should be used to create the file reference in the exportCore method.

Create a ByteArray which contains an encoded image of the canvas.

A pre-calculated Sprite containing a copy of the canvas object tree can be passed to support the export of lazy-loading image data.

Parameters

See also

Callback that allows additional painting on the sprite that will be exported as a bitmap.

Parameters

Encodes the given bitmap data to a byte array.

The default implementation uses PNG encoding.

Parameters

Exports the image using the provided export options.

In general, to make sure that asynchronous content is exported correctly, a sprite containing the canvas content should be passed using the canvasSprite parameter. For example, if the ImageNodeStyle is used with a remote SWF, the SWF will not be visible in the exported bitmap if this method is called directly without passing a pre-rendered sprite. Also, as this method will use a Flex FileReference instance to open a save dialog, this method should only be called in direct response to a user event (e.g. a mouse click or keypress handler). Otherwise, a security error will be thrown. The below example shows how the export function can be called with a pre-rendered sprite.

Parameters

See also

         // create a sprite containing the canvas content
         var printSprite:PrintSprite = canvasComponent.createSprite();
         
         // create a dialog that will not be shown until the sprite has finished rendering
         // any asynchronous content. As an alternative, we could also show the dialog immediately,
         // but enable the dialogs' submit button only when the canvas has finished rendering.
         var dialog:MyDialog = new MyExportDialog();
         dialog.addEventListener(MyDialogEvent.OK,function(evt:MyDialogEvent):void {
            // When a submit button is pressed in the custom dialog, this event is dispatched.
            // We can now call the export function in direct response to the user event
            // (mouse click on the ok button).
            new ImageSaveHandler().export(canvasComponent, "export.png", myExportOptions, printSprite);
         });
         
         if(!printSprite.paintComplete) {
           var onPaintComplete:Function = function(evt:Event):void {
             printSprite.removeEventListener(Event.COMPLETE,onPaintComplete);
             showDialog(dialog);
           };
           printSprite.addEventListener(Event.COMPLETE,onPaintComplete);
         } else {
           showDialog(dialog);
         }
         

This method is called by the export method and is expected to create the image file and save or download it using a FileReference created by createFileReference().

Subclasses have to override this method.

Parameters

Draws the canvas contents to a BitmapData instance.

A pre-calculated Sprite containing a copy of the canvas object tree can be passed to support the export of lazy-loading image data.

Parameters

See also

Called when the user chose the cancel button of the download dialog.

Parameters

Called when the export operation has finished succesfully.

This implementation removes the busy cursor.

Parameters

Called when the server sends a HTTP status.

This implementation is empty.

Parameters

Called when an IO error occurs while executing the image file download.

This implementation shows an alert message, traces the event and removes the busy cursor.

Parameters

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.

This implementation does nothing.

Parameters

Called when a security error occurs while executing the image file download.

This implementation shows an alert message, traces the event and removes the busy cursor.

Parameters

Called when the user has selected a location for the image file download.

This implementation sets the busy cursor.

Parameters