| Package | com.adobe.portfolio.previews |
| Class | public class Preview |
| Inheritance | Preview  NavSkinnableComponent spark.components.supportClasses.SkinnableComponent |
| Implements | IPreview |
| Language Version : | ActionScript 3.0 |
| Product Version : | Portfolio 10.0 |
| Runtime Versions : | Flash Player 10.1, AIR 2.0 |
| Property | Defined By | ||
|---|---|---|---|
| aspectRatio : Number | Preview | ||
| doubleClickEnabled : Boolean [override] [write-only] | Preview | ||
| model : IPreviewModel | Preview | ||
 | skinState : String | NavSkinnableComponent | |
| smallPreview : Boolean | Preview | ||
| usePlatformPreview : Boolean [read-only] | Preview | ||
| Property | Defined By | ||
|---|---|---|---|
| autoListen : AutoListen | NavSkinnableComponent | |
| autoWatch : AutoWatch | NavSkinnableComponent | |
| logger : ILogger [static] | Preview | ||
| _skinState : String | NavSkinnableComponent | |
| thumbnailMgr : ThumbnailManager [static] | Preview | ||
| Method | Defined By | ||
|---|---|---|---|
Preview() | Preview | ||
| addListenAndWatch():void | NavSkinnableComponent | |
generateThumbnail(id:*, attachment:IAttachment, previewSize:Point = null, enableThumbnailGeneration:Boolean = true, delayThumbnailGeneration:Boolean = false, downSampleOK:Boolean = true, onThumbComplete:Function = null):void | Preview | ||
isThumbnailState():Boolean | Preview | ||
| removeListenAndWatch():void | NavSkinnableComponent | |
| setCurrentState(stateName:String, playTransition:Boolean = true):void [override] | NavSkinnableComponent | |
stopPlayback():void | Preview | ||
| Method | Defined By | ||
|---|---|---|---|
| addListener(listener:IEventDispatcher, type:String, handler:Function, useCapture:Boolean = false, priority:int = 0):void | NavSkinnableComponent | |
| addWatcher(watcher:ChangeWatcher):void | NavSkinnableComponent | |
attachSkin():void [override] | Preview | ||
| detachSkin():void [override] | NavSkinnableComponent | |
getCurrentSkinState():String [override] | Preview | ||
initStates():void [override] | Preview | ||
measure():void [override] | Preview | ||
partAdded(partName:String, instance:Object):void [override] | Preview | ||
partRemoved(partName:String, instance:Object):void [override] | Preview | ||
requestMultiPageThumbnails(id:*, attachment:IAttachment, previewSize:Point = null, enableThumbnailGeneration:Boolean = true, delayThumbnailGeneration:Boolean = false, downSampleOK:Boolean = true, onThumbComplete:Function = null):void | Preview | ||
requestThumbnail(id:*, attachment:IAttachment, previewSize:Point, pageNumber:uint, downSampleOK:Boolean, onThumbComplete:Function = null):void | Preview | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the user requests to show info for the previewed content. | Preview | |||
| Dispatched when the user requests to extract the previewed content. | Preview | |||
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
| Skin Part | Description | Defined By | ||
|---|---|---|---|---|
audio:AudioPreview | Required: false Part Type: Static | Preview | ||
icon:mx.controls.Image | Required: false Part Type: Static | Preview | ||
scrollPad:ScrollPad | Required: false Part Type: Static | Preview | ||
thumbnail:mx.controls.Image | Required: false Part Type: Static | Preview | ||
video:VideoPreview | Required: false Part Type: Static | Preview | ||
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
| Skin State | Description | Defined By | ||
|---|---|---|---|---|
audio | Preview | |||
audioHover | Preview | |||
pagingThumbnail | Preview | |||
pagingThumbnailHover | Preview | |||
thumbnail | Preview | |||
thumbnailHover | Preview | |||
video | Preview | |||
videoHover | Preview | |||
| Constant | Defined By | ||
|---|---|---|---|
| AUDIO : String = audio [static] | Preview | ||
| PAGING_THUMBNAIL : String = pagingThumbnail [static] | Preview | ||
| STATE_DISABLED : String = disabled [static] | NavSkinnableComponent | |
| STATE_NORMAL : String = normal [static] | NavSkinnableComponent | |
| THUMBNAIL : String = thumbnail [static] | Preview | ||
| VIDEO : String = video [static] | Preview | ||
| aspectRatio | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesaspectRatio:NumberThis property can be used as the source for data binding.
public function get aspectRatio():Number public function set aspectRatio(value:Number):void| doubleClickEnabled | property |
doubleClickEnabled:Boolean [write-only] [override] public function set doubleClickEnabled(value:Boolean):void| logger | property |
protected static var logger:ILogger| model | property |
model:IPreviewModelThis property can be used as the source for data binding.
public function get model():IPreviewModel public function set model(value:IPreviewModel):void| smallPreview | property |
smallPreview:BooleanThis property can be used as the source for data binding.
public function get smallPreview():Boolean public function set smallPreview(value:Boolean):void| thumbnailMgr | property |
protected static var thumbnailMgr:ThumbnailManager| usePlatformPreview | property |
usePlatformPreview:Boolean [read-only] public function get usePlatformPreview():Boolean| Preview | () | Constructor |
public function Preview()| attachSkin | () | method |
override protected function attachSkin():void| generateThumbnail | () | method |
public function generateThumbnail(id:*, attachment:IAttachment, previewSize:Point = null, enableThumbnailGeneration:Boolean = true, delayThumbnailGeneration:Boolean = false, downSampleOK:Boolean = true, onThumbComplete:Function = null):voidParameters
id:* | |
attachment:IAttachment | |
previewSize:Point (default = null) | |
enableThumbnailGeneration:Boolean (default = true) | |
delayThumbnailGeneration:Boolean (default = false) | |
downSampleOK:Boolean (default = true) | |
onThumbComplete:Function (default = null) |
| getCurrentSkinState | () | method |
override protected function getCurrentSkinState():StringReturnsString |
| initStates | () | method |
override protected function initStates():void| isThumbnailState | () | method |
public function isThumbnailState():BooleanReturnsBoolean |
| measure | () | method |
override protected function measure():void| partAdded | () | method |
override protected function partAdded(partName:String, instance:Object):voidParameters
partName:String | |
instance:Object |
| partRemoved | () | method |
override protected function partRemoved(partName:String, instance:Object):voidParameters
partName:String | |
instance:Object |
| requestMultiPageThumbnails | () | method |
protected function requestMultiPageThumbnails(id:*, attachment:IAttachment, previewSize:Point = null, enableThumbnailGeneration:Boolean = true, delayThumbnailGeneration:Boolean = false, downSampleOK:Boolean = true, onThumbComplete:Function = null):voidParameters
id:* | |
attachment:IAttachment | |
previewSize:Point (default = null) | |
enableThumbnailGeneration:Boolean (default = true) | |
delayThumbnailGeneration:Boolean (default = false) | |
downSampleOK:Boolean (default = true) | |
onThumbComplete:Function (default = null) |
| requestThumbnail | () | method |
protected function requestThumbnail(id:*, attachment:IAttachment, previewSize:Point, pageNumber:uint, downSampleOK:Boolean, onThumbComplete:Function = null):voidParameters
id:* | |
attachment:IAttachment | |
previewSize:Point | |
pageNumber:uint | |
downSampleOK:Boolean | |
onThumbComplete:Function (default = null) |
| stopPlayback | () | method |
public function stopPlayback():void| handleCardInfo | Event |
com.adobe.portfolio.events.DocEventDispatched when the user requests to show info for the previewed content.
| handleExtract | Event |
com.adobe.portfolio.events.DocEventDispatched when the user requests to extract the previewed content.
| AUDIO | Constant |
public static const AUDIO:String = audio| PAGING_THUMBNAIL | Constant |
public static const PAGING_THUMBNAIL:String = pagingThumbnail| THUMBNAIL | Constant |
public static const THUMBNAIL:String = thumbnail| VIDEO | Constant |
public static const VIDEO:String = video