Packagetwaver.network
Classpublic class Overview
InheritanceOverview Inheritance mx.core.UIComponent
Implements mx.managers.IFocusManagerComponent

This component works with network component and display an overview of network canvas so you can see the whole network area at a glance. Also, this component allows navigation operations by mouse.

Please not that this overview is just a network data read-only view and not able to do element selection, element movement and other regular canvas operations supported in network canvas.

For example:

	 var overview:Overview = new Overview();
	 overview.backgroundColor = 0xAAAAAA;
	 overview.backgroundAlpha = 0.7;
	 //...
	 network.parent.addChild(overview);
	 



Public Properties
 PropertyDefined By
  animate : Boolean
Get the value that whether overview will show up with animation effect.
Overview
  backgroundAlpha : Number
Get the transparent alpha value for this overview background.
Overview
  backgroundColor : Object
Get the background color of this overview component.
Overview
  fillAlpha : Number
Get overview component fill transparency.
Overview
  fillColor : Object
Get overview component fill color.
Overview
  network : Network
Get the connected network component.
Overview
  outlineAlpha : Number
Get overview outline color transparency.
Overview
  outlineColor : Number
Get overview component outline color.
Overview
  outlineWidth : Number
Get overview outline stroke width.
Overview
  padding : Number
Get the insets blank space of this overview component.
Overview
  selectAlpha : Number
Get selected area draw color transparency.
Overview
  selectColor : Number
Get selected area draw color.
Overview
  selectWidth : Number
Get selected area draw stroke width.
Overview
Public Methods
 MethodDefined By
  
Overview(network:Network = null)
Network overview constructor.
Overview
  
dispatchPropertyChangeEvent2(property:String, oldValue:Object, newValue:Object):Boolean
Dispatch overview property change event to all listeners.
Overview
  
invalidateOverview(e:* = null):void
Call this to invalidate overview canvas.
Overview
Protected Methods
 MethodDefined By
  
onPropertyChanged(property:String, oldValue:Object, newValue:Object):void
Called when property changed.
Overview
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override]
Overview
Property Detail
animateproperty
animate:Boolean

Get the value that whether overview will show up with animation effect. Default value is true.


Implementation
    public function get animate():Boolean
    public function set animate(value:Boolean):void
backgroundAlphaproperty 
backgroundAlpha:Number

Get the transparent alpha value for this overview background. Default value is 1, no transparency.


Implementation
    public function get backgroundAlpha():Number
    public function set backgroundAlpha(value:Number):void
backgroundColorproperty 
backgroundColor:Object

Get the background color of this overview component.


Implementation
    public function get backgroundColor():Object
    public function set backgroundColor(value:Object):void
fillAlphaproperty 
fillAlpha:Number

Get overview component fill transparency. Default value is 0.7


Implementation
    public function get fillAlpha():Number
    public function set fillAlpha(value:Number):void
fillColorproperty 
fillColor:Object

Get overview component fill color. Default value is 0xB8D3F0.


Implementation
    public function get fillColor():Object
    public function set fillColor(value:Object):void
networkproperty 
network:Network

Get the connected network component.


Implementation
    public function get network():Network
    public function set network(value:Network):void
outlineAlphaproperty 
outlineAlpha:Number

Get overview outline color transparency. Default value is 1.


Implementation
    public function get outlineAlpha():Number
    public function set outlineAlpha(value:Number):void
outlineColorproperty 
outlineColor:Number

Get overview component outline color. Default value is 0xB8D3F0.


Implementation
    public function get outlineColor():Number
    public function set outlineColor(value:Number):void
outlineWidthproperty 
outlineWidth:Number

Get overview outline stroke width. Default value is 1.


Implementation
    public function get outlineWidth():Number
    public function set outlineWidth(value:Number):void
paddingproperty 
padding:Number

Get the insets blank space of this overview component. Default value is 1.


Implementation
    public function get padding():Number
    public function set padding(value:Number):void
selectAlphaproperty 
selectAlpha:Number

Get selected area draw color transparency. Default value is 1, no transparency. Selected area is network canvas scroll view port covered area related to the whole canvas.


Implementation
    public function get selectAlpha():Number
    public function set selectAlpha(value:Number):void
selectColorproperty 
selectColor:Number

Get selected area draw color. Default color is 0x0000FF. Selected area is network canvas scroll view port covered area related to the whole canvas.


Implementation
    public function get selectColor():Number
    public function set selectColor(value:Number):void
selectWidthproperty 
selectWidth:Number

Get selected area draw stroke width. Default value is 1 Selected area is network canvas scroll view port covered area related to the whole canvas.


Implementation
    public function get selectWidth():Number
    public function set selectWidth(value:Number):void
Constructor Detail
Overview()Constructor
public function Overview(network:Network = null)

Network overview constructor. Create an overview for the specified network component.

Parameters
network:Network (default = null) — the network this overview works with. This overview will display the specified network canvas with a reduced scale.
Method Detail
dispatchPropertyChangeEvent2()method
public function dispatchPropertyChangeEvent2(property:String, oldValue:Object, newValue:Object):Boolean

Dispatch overview property change event to all listeners.

Parameters

property:String — property name of this change
 
oldValue:Object — old value before the change.
 
newValue:Object — new value after the change

Returns
Boolean — true if dispatched successfully, false otherwise.
invalidateOverview()method 
public function invalidateOverview(e:* = null):void

Call this to invalidate overview canvas. This will repaint overview canvas.

Parameters

e:* (default = null) — some parameters. No use so far.

onPropertyChanged()method 
protected function onPropertyChanged(property:String, oldValue:Object, newValue:Object):void

Called when property changed. This is an empty method but subclasses can overwrite this method to do some extra job.

Parameters

property:String — property name of the change.
 
oldValue:Object — old value before the change.
 
newValue:Object — new value after the change.

updateDisplayList()method 
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

Parameters

unscaledWidth:Number
 
unscaledHeight:Number