Packageorg.openzoom.flex.components
Classpublic final class MultiScaleContainer
InheritanceMultiScaleContainer Inheritance mx.core.UIComponent
Implementsorg.openzoom.flash.net.ILoaderClient

Generic container for multiscale content.

Default MXML Propertychildren


Public Properties
 PropertyDefined by
  children : Array
MultiScaleContainer
  constraint : IViewportConstraint
MultiScaleContainer
  controllers : Array
Controllers of type IViewportController applied to this MultiScaleImage.
MultiScaleContainer
  loader : INetworkQueue
MultiScaleContainer
  numChildren : int
[read-only]
MultiScaleContainer
  scale : Number
Scale of the scene.
MultiScaleContainer
  scene : IMultiScaleScene
[read-only]
MultiScaleContainer
  sceneHeight : Number
Indicates the height of the scene, in pixels.
MultiScaleContainer
  sceneWidth : Number
Indicates the width of the scene, in pixels.
MultiScaleContainer
  transformer : IViewportTransformer
MultiScaleContainer
  viewport : NormalizedViewport
[read-only]
MultiScaleContainer
  viewportHeight : Number
Vertical dimension of the viewport.
MultiScaleContainer
  viewportWidth : Number
Horizontal dimension of the viewport.
MultiScaleContainer
  viewportX : Number
Horizontal coordinate of the viewport.
MultiScaleContainer
  viewportY : Number
Vertical coordinate of the viewport.
MultiScaleContainer
  zoom : Number
Zoom level of the viewport.
MultiScaleContainer
Public Methods
 MethodDefined by
  
MultiScaleContainer()
Constructor.
MultiScaleContainer
  
addChild(child:DisplayObject):DisplayObject
MultiScaleContainer
  
addChildAt(child:DisplayObject, index:int):DisplayObject
MultiScaleContainer
  
fitToBounds(bounds:Rectangle, scale:Number = 1.0, immediately:Boolean = false):void
Show a rectangular area of the scene inside the viewport.
MultiScaleContainer
  
getChildAt(index:int):DisplayObject
MultiScaleContainer
  
getChildByName(name:String):DisplayObject
MultiScaleContainer
  
getChildIndex(child:DisplayObject):int
MultiScaleContainer
  
localToScene(point:Point):Point
Converts the point object from the viewport's container (local) coordinates to scene coordinates.
MultiScaleContainer
  
panBy(deltaX:Number, deltaY:Number, immediately:Boolean = false):void
Move the viewport.
MultiScaleContainer
  
panTo(x:Number, y:Number, immediately:Boolean = false):void
Move the viewport.
MultiScaleContainer
  
removeChild(child:DisplayObject):DisplayObject
MultiScaleContainer
  
removeChildAt(index:int):DisplayObject
MultiScaleContainer
  
sceneToLocal(point:Point):Point
Converts the point object from scene coordinates to the viewport's container (local) coordinates.
MultiScaleContainer
  
setChildIndex(child:DisplayObject, index:int):void
MultiScaleContainer
  
showAll(immediately:Boolean = false):void
Fit entire scene into the viewport.
MultiScaleContainer
  
swapChildren(child1:DisplayObject, child2:DisplayObject):void
MultiScaleContainer
  
swapChildrenAt(index1:int, index2:int):void
MultiScaleContainer
  
zoomBy(factor:Number, transformX:Number = 0.5, transformY:Number = 0.5, immediately:Boolean = false):void
Zoom the viewport by a factor.
MultiScaleContainer
  
zoomTo(zoom:Number, transformX:Number = 0.5, transformY:Number = 0.5, immediately:Boolean = false):void
Zoom the viewport to a zoom level z.
MultiScaleContainer
Property detail
childrenproperty
children:Array  [read-write]Implementation
    public function get children():Array
    public function set children(value:Array):void
constraintproperty 
constraint:IViewportConstraint  [read-write]

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

Implementation
    public function get constraint():IViewportConstraint
    public function set constraint(value:IViewportConstraint):void

See also

org.openzoom.flash.viewport.constraints.DefaultConstraint
org.openzoom.flash.viewport.constraints.NullConstraint
controllersproperty 
controllers:Array  [read-write]

Controllers of type IViewportController applied to this MultiScaleImage. For example, viewport controllers are used to navigate the MultiScaleImage by mouse or keyboard.

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

Implementation
    public function get controllers():Array
    public function set controllers(value:Array):void

See also

org.openzoom.flash.viewport.controllers.MouseController
org.openzoom.flash.viewport.controllers.KeyboardController
org.openzoom.flash.viewport.controllers.ContextMenuController
loaderproperty 
loader:INetworkQueue  [read-write]Implementation
    public function get loader():INetworkQueue
    public function set loader(value:INetworkQueue):void
numChildrenproperty 
numChildren:int  [read-only]Implementation
    public function get numChildren():int
scaleproperty 
scale:Number  [read-write]

Scale of the scene.

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

Implementation
    public function get scale():Number
    public function set scale(value:Number):void
sceneproperty 
scene:IMultiScaleScene  [read-only]

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

Implementation
    public function get scene():IMultiScaleScene
sceneHeightproperty 
sceneHeight:Number  [read-write]

Indicates the height of the scene, in pixels.

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

Implementation
    public function get sceneHeight():Number
    public function set sceneHeight(value:Number):void
sceneWidthproperty 
sceneWidth:Number  [read-write]

Indicates the width of the scene, in pixels.

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

Implementation
    public function get sceneWidth():Number
    public function set sceneWidth(value:Number):void
transformerproperty 
transformer:IViewportTransformer  [read-write]

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

Implementation
    public function get transformer():IViewportTransformer
    public function set transformer(value:IViewportTransformer):void
viewportproperty 
viewport:NormalizedViewport  [read-only]

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

Implementation
    public function get viewport():NormalizedViewport
viewportHeightproperty 
viewportHeight:Number  [read-write]

Vertical dimension of the viewport.

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

Implementation
    public function get viewportHeight():Number
    public function set viewportHeight(value:Number):void
viewportWidthproperty 
viewportWidth:Number  [read-write]

Horizontal dimension of the viewport.

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

Implementation
    public function get viewportWidth():Number
    public function set viewportWidth(value:Number):void
viewportXproperty 
viewportX:Number  [read-write]

Horizontal coordinate of the viewport.

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

Implementation
    public function get viewportX():Number
    public function set viewportX(value:Number):void
viewportYproperty 
viewportY:Number  [read-write]

Vertical coordinate of the viewport.

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

Implementation
    public function get viewportY():Number
    public function set viewportY(value:Number):void
zoomproperty 
zoom:Number  [read-write]

Zoom level of the viewport. Scene fits exactly into viewport at value 1.

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

Implementation
    public function get zoom():Number
    public function set zoom(value:Number):void
Constructor detail
MultiScaleContainer()constructor
public function MultiScaleContainer()

Constructor.

Method detail
addChild()method
public override function addChild(child:DisplayObject):DisplayObjectParameters
child:DisplayObject

Returns
DisplayObject
addChildAt()method 
public override function addChildAt(child:DisplayObject, index:int):DisplayObjectParameters
child:DisplayObject
 
index:int

Returns
DisplayObject
fitToBounds()method 
public function fitToBounds(bounds:Rectangle, scale:Number = 1.0, immediately:Boolean = false):void

Show a rectangular area of the scene inside the viewport.

Parameters
bounds:Rectangle — Rectangle to be shown in the viewport.
 
scale:Number (default = 1.0) — Scale at which the rectangle is beeing displayed, e.g. useful for displaying some space around the rectangle.
 
immediately:Boolean (default = false)
getChildAt()method 
public override function getChildAt(index:int):DisplayObjectParameters
index:int

Returns
DisplayObject
getChildByName()method 
public override function getChildByName(name:String):DisplayObjectParameters
name:String

Returns
DisplayObject
getChildIndex()method 
public override function getChildIndex(child:DisplayObject):intParameters
child:DisplayObject

Returns
int
localToScene()method 
public function localToScene(point:Point):Point

Converts the point object from the viewport's container (local) coordinates to scene coordinates.

Parameters
point:Point

Returns
Point
panBy()method 
public function panBy(deltaX:Number, deltaY:Number, immediately:Boolean = false):void

Move the viewport.

Parameters
deltaX:Number — Horizontal translation delta
 
deltaY:Number — Vertical translation delta
 
immediately:Boolean (default = false)
panTo()method 
public function panTo(x:Number, y:Number, immediately:Boolean = false):void

Move the viewport.

Parameters
x:Number — Horizontal coordinate
 
y:Number — Vertical coordinate
 
immediately:Boolean (default = false)
removeChild()method 
public override function removeChild(child:DisplayObject):DisplayObjectParameters
child:DisplayObject

Returns
DisplayObject
removeChildAt()method 
public override function removeChildAt(index:int):DisplayObjectParameters
index:int

Returns
DisplayObject
sceneToLocal()method 
public function sceneToLocal(point:Point):Point

Converts the point object from scene coordinates to the viewport's container (local) coordinates.

Parameters
point:Point

Returns
Point
setChildIndex()method 
public override function setChildIndex(child:DisplayObject, index:int):voidParameters
child:DisplayObject
 
index:int
showAll()method 
public function showAll(immediately:Boolean = false):void

Fit entire scene into the viewport.

Parameters
immediately:Boolean (default = false)
swapChildren()method 
public override function swapChildren(child1:DisplayObject, child2:DisplayObject):voidParameters
child1:DisplayObject
 
child2:DisplayObject
swapChildrenAt()method 
public override function swapChildrenAt(index1:int, index2:int):voidParameters
index1:int
 
index2:int
zoomBy()method 
public function zoomBy(factor:Number, transformX:Number = 0.5, transformY:Number = 0.5, immediately:Boolean = false):void

Zoom the viewport by a factor.

Parameters
factor:Number — Multiplier for the zoom.
 
transformX:Number (default = 0.5) — Horizontal coordinate of the zooming center
 
transformY:Number (default = 0.5) — Vertical coordinate of the zooming center
 
immediately:Boolean (default = false)
zoomTo()method 
public function zoomTo(zoom:Number, transformX:Number = 0.5, transformY:Number = 0.5, immediately:Boolean = false):void

Zoom the viewport to a zoom level z.

Parameters
zoom:Number — Target value for the viewport's zoom property
 
transformX:Number (default = 0.5) — Horizontal coordinate of the zooming center
 
transformY:Number (default = 0.5) — Vertical coordinate of the zooming center
 
immediately:Boolean (default = false)