Packagecom.afcomponents.umap.interfaces
Interfacepublic interface IMapControl extends IMapObject, flash.events.IEventDispatcher
ImplementorsMapControl, UIMapControl

IMapControl is the basic interface for UMap gui control objects.



Public Properties
 PropertyDefined by
  align : Align
Gets or sets the control's alignment.
IMapControl
 InheritedasDisplayObject : DisplayObject
Returns reference to the object as a DisplayObject instance.
IMapObject
 Inheritedcore : UMap
Returns reference to the core UMap object.
IMapObject
 Inheritedid : uint
Gets or sets the ID of the object.
IMapObject
  minSize : Size
Gets or sets control's minimum size.
IMapControl
 Inheritedname : String
Gets or sets the name of the object.
IMapObject
  offset : Offset
Gets or sets the control's offset position.
IMapControl
 Inheritedowner : IMapObjectContainer
Returns reference to the owner container object.
IMapObject
  padding : Point
Gets or sets the control's padding value.
IMapControl
  stackAlignment : String
Gets or sets control's stack alignment.
IMapControl
  stackPadding : Point
Gets or sets control's stack padding value.
IMapControl
  visible : Boolean
IMapControl
Public Methods
 MethodDefined by
 Inherited
dispose():void
Releases all the resources accuired by the object.
IMapObject
  
IMapControl
  
init():void
Invoked when control has been attached to GuiManager, or when UMap has been initialized.
IMapControl
  
ready():void
Invoked when UMap enters ready() state.
IMapControl
  
refresh():void
Refreshes the control.
IMapControl
 Inherited
remove():void
Removes the object from the owner container object.
IMapObject
  
Invoked by GuiManager to report the available space this control can occupy.
IMapControl
 Inherited
Adds the object to the specified IMapObjectContainer.
IMapObject
  
setRefreshCallback(refresh:Function):void
Sets the callback function which should be called by the control after it's size has been updated.
IMapControl
 Inherited
toString():String
Returns a textual representation of the object.
IMapObject
  
updateMapType(mapType:IMapType):void
Invoked when map type has been updated.
IMapControl
  
updatePosition(latlng:LatLng):void
Invoked when map center has been updated.
IMapControl
  
updateSize(width:Number, height:Number):void
Invoked when the UMap Component size has been updated.
IMapControl
  
updateZoom(zoom:Number):void
Invoked when map zoom level has been updated.
IMapControl
Property detail
alignproperty
align:Align  [read-write]

Gets or sets the control's alignment. Use Align constants.

Implementation
    public function get align():Align
    public function set align(value:Align):void
minSizeproperty 
minSize:Size  [read-write]

Gets or sets control's minimum size.

Implementation
    public function get minSize():Size
    public function set minSize(value:Size):void
offsetproperty 
offset:Offset  [read-write]

Gets or sets the control's offset position.

Implementation
    public function get offset():Offset
    public function set offset(value:Offset):void
paddingproperty 
padding:Point  [read-write]

Gets or sets the control's padding value.

Implementation
    public function get padding():Point
    public function set padding(value:Point):void
stackAlignmentproperty 
stackAlignment:String  [read-write]

Gets or sets control's stack alignment. Can be either MapControl.STACK_VERTICAL or MapControl.STACK_HORIZONTAL.

Implementation
    public function get stackAlignment():String
    public function set stackAlignment(value:String):void
stackPaddingproperty 
stackPadding:Point  [read-write]

Gets or sets control's stack padding value.

Implementation
    public function get stackPadding():Point
    public function set stackPadding(value:Point):void
visibleproperty 
visible:Boolean  [read-write]Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Method detail
getBoundsXY()method
public function getBoundsXY():Bounds

Returns
Bounds
init()method 
public function init():void

Invoked when control has been attached to GuiManager, or when UMap has been initialized.

ready()method 
public function ready():void

Invoked when UMap enters ready() state.

refresh()method 
public function refresh():void

Refreshes the control.

setAvailableSize()method 
public function setAvailableSize(size:Size):void

Invoked by GuiManager to report the available space this control can occupy.

Parameters
size:Size — Dimensions of the available space.
setRefreshCallback()method 
public function setRefreshCallback(refresh:Function):void

Sets the callback function which should be called by the control after it's size has been updated. GuiManager uses this function to re-align the control.

Parameters
refresh:Function
updateMapType()method 
public function updateMapType(mapType:IMapType):void

Invoked when map type has been updated.

Parameters
mapType:IMapType — Reference to the new map type.
updatePosition()method 
public function updatePosition(latlng:LatLng):void

Invoked when map center has been updated.

Parameters
latlng:LatLng — Geographical coordinates of the new map center.
updateSize()method 
public function updateSize(width:Number, height:Number):void

Invoked when the UMap Component size has been updated.

Parameters
width:Number — New width of the component.
 
height:Number — New height of the component.
updateZoom()method 
public function updateZoom(zoom:Number):void

Invoked when map zoom level has been updated.

Parameters
zoom:Number — New zoom level.