Packagestimulsoft.viewer.canvas
Classpublic class StiViewerCanvas
InheritanceStiViewerCanvas Inheritance mx.containers.Canvas



Public Properties
 PropertyDefined By
  currentPage : int
[read-only]
StiViewerCanvas
  pageViewMode : String
StiViewerCanvas
  report : StiReport
[read-only]
StiViewerCanvas
  viewerControl : StiViewerFx
StiViewerCanvas
  viewHeight : Number
[read-only]
StiViewerCanvas
  viewWidth : Number
[read-only]
StiViewerCanvas
  zoom : Number
StiViewerCanvas
Public Methods
 MethodDefined By
  
StiViewerCanvas
  
StiViewerCanvas
  
clearAll():void
StiViewerCanvas
  
StiViewerCanvas
  
StiViewerCanvas
  
StiViewerCanvas
  
isVisualVisible(pageVisual:StiPageVisual):Boolean
StiViewerCanvas
  
StiViewerCanvas
  
StiViewerCanvas
  
StiViewerCanvas
  
StiViewerCanvas
  
setZoomMultiplePages(pagesByWidth:int, pagesByHeight:int):void
StiViewerCanvas
  
StiViewerCanvas
  
StiViewerCanvas
  
StiViewerCanvas
  
StiViewerCanvas
  
StiViewerCanvas
Protected Methods
 MethodDefined By
  
[override]
StiViewerCanvas
  
StiViewerCanvas
  
StiViewerCanvas
  
StiViewerCanvas
Property Detail
currentPageproperty
currentPage:int  [read-only]


Implementation
    public function get currentPage():int
pageViewModeproperty 
pageViewMode:String


Implementation
    public function get pageViewMode():String
    public function set pageViewMode(value:String):void
reportproperty 
report:StiReport  [read-only]


Implementation
    public function get report():StiReport
scrollBoxproperty 
sti_internal var scrollBox:StiScrollBox

viewerControlproperty 
viewerControl:StiViewerFx


Implementation
    public function get viewerControl():StiViewerFx
    public function set viewerControl(value:StiViewerFx):void
viewHeightproperty 
viewHeight:Number  [read-only]


Implementation
    public function get viewHeight():Number
viewWidthproperty 
viewWidth:Number  [read-only]


Implementation
    public function get viewWidth():Number
zoomproperty 
zoom:Number


Implementation
    public function get zoom():Number
    public function set zoom(value:Number):void
Constructor Detail
StiViewerCanvas()Constructor
public function StiViewerCanvas()



Method Detail
addBookmarkVisual()method
public function addBookmarkVisual(visual:StiBookmarkVisual):void

Parameters

visual:StiBookmarkVisual

clearAll()method 
public function clearAll():void

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

getBookmark()method 
public function getBookmark():StiBookmarkVisual

Returns
StiBookmarkVisual
getComponentRect()method 
public function getComponentRect(comp:StiComponent, pageVisual:StiPageVisual = null):StiRectangle

Parameters

comp:StiComponent
 
pageVisual:StiPageVisual (default = null)

Returns
StiRectangle
getPageVisualFromMouse()method 
public function getPageVisualFromMouse():StiPageVisual

Returns
StiPageVisual
isVisualVisible()method 
public function isVisualVisible(pageVisual:StiPageVisual):Boolean

Parameters

pageVisual:StiPageVisual

Returns
Boolean
onTransitionEnd()method 
protected function onTransitionEnd(event:StiTransitionEvent):void

Parameters

event:StiTransitionEvent

onTransitionStart()method 
protected function onTransitionStart(event:StiTransitionEvent):void

Parameters

event:StiTransitionEvent

onTransitionStop()method 
protected function onTransitionStop(event:StiTransitionEvent):void

Parameters

event:StiTransitionEvent

removeBookmarkVisual()method 
public function removeBookmarkVisual(visual:StiBookmarkVisual):void

Parameters

visual:StiBookmarkVisual

scrollToComponent()method 
public function scrollToComponent(component:StiComponent):void

Parameters

component:StiComponent

scrollToCurrentPage()method 
public function scrollToCurrentPage():void

setZoomByDefault()method 
public function setZoomByDefault():Boolean

Returns
Boolean
setZoomMultiplePages()method 
public function setZoomMultiplePages(pagesByWidth:int, pagesByHeight:int):void

Parameters

pagesByWidth:int
 
pagesByHeight:int

setZoomOnePage()method 
public function setZoomOnePage():void

setZoomPageWidth()method 
public function setZoomPageWidth():void

setZoomTwoPages()method 
public function setZoomTwoPages():void

updateHighlights()method 
public function updateHighlights():void

updatePagesPlacement()method 
public function updatePagesPlacement():void