Packagecom.adobe.portfolio.previews
Classpublic class PreviewHUD
InheritancePreviewHUD Inheritance NavSkinnableComponent Inheritance spark.components.supportClasses.SkinnableComponent

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The PreviewHUD class extends NavSkinnableComponent to display the floating HUD (head-up-display) associated with a Preview.



Public Properties
 PropertyDefined By
  pageNumberString : String
The current pageNumber in String form.
PreviewHUD
  pageTotalNumber : uint
The current page total (count).
PreviewHUD
  pageTotalString : String
The current page total (count) in String form.
PreviewHUD
  preview : Preview
The Preview component associated with this PreviewHUD.
PreviewHUD
  previewMultiPageModel : IPreviewMultiPageModel
The current previewMultiPageModel (may return null).
PreviewHUD
 InheritedskinState : String
The current skin state
NavSkinnableComponent
Protected Properties
 PropertyDefined By
 InheritedautoListen : AutoListen
NavSkinnableComponent
 InheritedautoWatch : AutoWatch
NavSkinnableComponent
  fadeTimer : Timer
PreviewHUD
  isDraggingHUD : Boolean
PreviewHUD
  pageInputActive : Boolean
PreviewHUD
  previewModel : IPreviewModel
PreviewHUD
  rollOver : Boolean = false
PreviewHUD
  visibleState : String
[read-only]
PreviewHUD
  xMouseDown : Number
PreviewHUD
  xOrig : Number
PreviewHUD
  yMouseDown : Number
PreviewHUD
  yOrig : Number
PreviewHUD
Public Methods
 MethodDefined By
  
Constructor.
PreviewHUD
 Inherited
Creates autoListen and autoWatch for automatically tracking listeners and watchers.
NavSkinnableComponent
 Inherited
Uses autoListen and autoWatch to remove all listeners and watchers.
NavSkinnableComponent
  
setCurrentState(stateName:String, playTransition:Boolean = true):void
[override] Sets the current state of the HUD and its skin.
PreviewHUD
  
Updates the current state of the HUD.
PreviewHUD
Protected Methods
 MethodDefined By
 Inherited
addListener(listener:IEventDispatcher, type:String, handler:Function, useCapture:Boolean = false, priority:int = 0):void
NavSkinnableComponent
 Inherited
addWatcher(watcher:ChangeWatcher):void
NavSkinnableComponent
  
attachSkin():void
[override]
PreviewHUD
 Inherited
detachSkin():void
[override]
NavSkinnableComponent
  
fadeOut(e:TimerEvent):void
PreviewHUD
 Inherited
[override]
NavSkinnableComponent
  
globalToParentLocal(x:Number, y:Number):Point
PreviewHUD
  
handleFileExtract(event:MouseEvent):void
PreviewHUD
  
handleInfo(event:MouseEvent):void
PreviewHUD
  
handleMouseDown(event:MouseEvent):void
PreviewHUD
  
handleMouseMove(event:MouseEvent):void
PreviewHUD
  
handleMouseUp(event:MouseEvent):void
PreviewHUD
  
handlePageDown(event:MouseEvent):void
PreviewHUD
  
handlePageInput(event:Event):void
PreviewHUD
  
handlePageInputMouseDown(event:Event):void
PreviewHUD
  
handlePageUp(event:MouseEvent):void
PreviewHUD
  
handleParentMouseMove(event:MouseEvent):void
PreviewHUD
  
handleParentRollOut(event:MouseEvent):void
PreviewHUD
  
handleParentRollOver(event:MouseEvent):void
PreviewHUD
  
handleRollOut(event:MouseEvent):void
PreviewHUD
  
handleRollOver(event:MouseEvent):void
PreviewHUD
  
initStates():void
[override]
PreviewHUD
  
PreviewHUD
  
pageNumberChanged(val:uint):void
PreviewHUD
  
pageTotalChanged(val:uint):void
PreviewHUD
  
partAdded(partName:String, instance:Object):void
[override]
PreviewHUD
 Inherited
partRemoved(partName:String, instance:Object):void
[override]
NavSkinnableComponent
  
startFadeOutTimer(delay:int = 3000):void
PreviewHUD
Skin Parts

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
  
extractBtn:IconButton
Required: false Part Type: Static
An optional skin part that shows the extract file button.
PreviewHUD
  
infoBtn:IconButton
Required: false Part Type: Static
An optional skin part that shows the info file button.
PreviewHUD
  
pageDown:IconButton
Required: false Part Type: Static
An optional skin part that shows the pageDown button.
PreviewHUD
  
pageInput:spark.components.TextInput
Required: false Part Type: Static
An optional skin part used for entering page numbers.
PreviewHUD
  
pageTotal:spark.components.supportClasses.TextBase
Required: false Part Type: Static
An optional skin part used for displaying the total number of pages.
PreviewHUD
  
pageUp:IconButton
Required: false Part Type: Static
An optional skin part that shows the pageUp button.
PreviewHUD
Public Constants
 ConstantDefined By
  STATE_DISABLED : String = disabled
[static] The "disabled" state of a PreviewHUD and its skin.
PreviewHUD
  STATE_MULTI_PAGE : String = multiPage
[static] The "multiPage" state of a PreviewHUD and its skin.
PreviewHUD
 InheritedSTATE_NORMAL : String = normal
[static]
NavSkinnableComponent
  STATE_SINGLE_PAGE : String = singlePage
[static] The "singlePage" state of a PreviewHUD and its skin.
PreviewHUD
Property Detail
fadeTimerproperty
protected var fadeTimer:Timer

isDraggingHUDproperty 
protected var isDraggingHUD:Boolean

pageInputActiveproperty 
protected var pageInputActive:Boolean

pageNumberStringproperty 
pageNumberString:String

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The current pageNumber in String form.

This property can be used as the source for data binding.


Implementation
    public function get pageNumberString():String
    public function set pageNumberString(value:String):void
pageTotalNumberproperty 
pageTotalNumber:uint

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The current page total (count).

This property can be used as the source for data binding.


Implementation
    public function get pageTotalNumber():uint
    public function set pageTotalNumber(value:uint):void
pageTotalStringproperty 
pageTotalString:String

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The current page total (count) in String form.

This property can be used as the source for data binding.


Implementation
    public function get pageTotalString():String
    public function set pageTotalString(value:String):void
previewproperty 
public var preview:Preview

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The Preview component associated with this PreviewHUD.

previewModelproperty 
protected var previewModel:IPreviewModel

previewMultiPageModelproperty 
previewMultiPageModel:IPreviewMultiPageModel

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The current previewMultiPageModel (may return null).

This property can be used as the source for data binding.


Implementation
    public function get previewMultiPageModel():IPreviewMultiPageModel
    public function set previewMultiPageModel(value:IPreviewMultiPageModel):void
rollOverproperty 
protected var rollOver:Boolean = false

visibleStateproperty 
visibleState:String  [read-only]


Implementation
    protected function get visibleState():String
xMouseDownproperty 
protected var xMouseDown:Number

xOrigproperty 
protected var xOrig:Number

yMouseDownproperty 
protected var yMouseDown:Number

yOrigproperty 
protected var yOrig:Number

Constructor Detail
PreviewHUD()Constructor
public function PreviewHUD()

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Constructor.

Method Detail
attachSkin()method
override protected function attachSkin():void

fadeOut()method 
protected function fadeOut(e:TimerEvent):void

Parameters

e:TimerEvent

globalToParentLocal()method 
protected function globalToParentLocal(x:Number, y:Number):Point

Parameters

x:Number
 
y:Number

Returns
Point
handleFileExtract()method 
protected function handleFileExtract(event:MouseEvent):void

Parameters

event:MouseEvent

handleInfo()method 
protected function handleInfo(event:MouseEvent):void

Parameters

event:MouseEvent

handleMouseDown()method 
protected function handleMouseDown(event:MouseEvent):void

Parameters

event:MouseEvent

handleMouseMove()method 
protected function handleMouseMove(event:MouseEvent):void

Parameters

event:MouseEvent

handleMouseUp()method 
protected function handleMouseUp(event:MouseEvent):void

Parameters

event:MouseEvent

handlePageDown()method 
protected function handlePageDown(event:MouseEvent):void

Parameters

event:MouseEvent

handlePageInput()method 
protected function handlePageInput(event:Event):void

Parameters

event:Event

handlePageInputMouseDown()method 
protected function handlePageInputMouseDown(event:Event):void

Parameters

event:Event

handlePageUp()method 
protected function handlePageUp(event:MouseEvent):void

Parameters

event:MouseEvent

handleParentMouseMove()method 
protected function handleParentMouseMove(event:MouseEvent):void

Parameters

event:MouseEvent

handleParentRollOut()method 
protected function handleParentRollOut(event:MouseEvent):void

Parameters

event:MouseEvent

handleParentRollOver()method 
protected function handleParentRollOver(event:MouseEvent):void

Parameters

event:MouseEvent

handleRollOut()method 
protected function handleRollOut(event:MouseEvent):void

Parameters

event:MouseEvent

handleRollOver()method 
protected function handleRollOver(event:MouseEvent):void

Parameters

event:MouseEvent

initStates()method 
override protected function initStates():void

modelChanged()method 
protected function modelChanged(val:IPreviewModel):void

Parameters

val:IPreviewModel

pageNumberChanged()method 
protected function pageNumberChanged(val:uint):void

Parameters

val:uint

pageTotalChanged()method 
protected function pageTotalChanged(val:uint):void

Parameters

val:uint

partAdded()method 
override protected function partAdded(partName:String, instance:Object):void

Parameters

partName:String
 
instance:Object

setCurrentState()method 
override public function setCurrentState(stateName:String, playTransition:Boolean = true):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Sets the current state of the HUD and its skin.

Parameters

stateName:String
 
playTransition:Boolean (default = true)

startFadeOutTimer()method 
protected function startFadeOutTimer(delay:int = 3000):void

Parameters

delay:int (default = 3000)

updateCurrentState()method 
public function updateCurrentState():void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Updates the current state of the HUD.

Constant Detail
STATE_DISABLEDConstant
public static const STATE_DISABLED:String = disabled

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The "disabled" state of a PreviewHUD and its skin.

STATE_MULTI_PAGEConstant 
public static const STATE_MULTI_PAGE:String = multiPage

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The "multiPage" state of a PreviewHUD and its skin.

STATE_SINGLE_PAGEConstant 
public static const STATE_SINGLE_PAGE:String = singlePage

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The "singlePage" state of a PreviewHUD and its skin.