| Package | com.afcomponents.umap.gui |
| Class | public class UIMapControl |
| Inheritance | UIMapControl  fl.core.UIComponent |
| Implements | IMapControl, IMapObject |
| Subclasses | MapTypeControl, PositionControl, ScaleControl, ZoomControl |
| Property | Defined by | ||
|---|---|---|---|
| align : Align
Gets or sets the control's alignment.
| UIMapControl | ||
| asDisplayObject : DisplayObject [read-only]
Returns reference to the object as a DisplayObject instance.
| UIMapControl | ||
| core : UMap
[read-only]
Returns reference to the core UMap object.
| UIMapControl | ||
| display : String | UIMapControl | ||
| DISPLAY_COMPACT : String = "compact" [static]
| UIMapControl | ||
| DISPLAY_EXPANDED : String = "expanded" [static]
| UIMapControl | ||
| id : uint
Gets or sets the ID of the object.
| UIMapControl | ||
| minSize : Size
Gets or sets control's minimum size.
| UIMapControl | ||
| name : String | UIMapControl | ||
| offset : Offset
Gets or sets the control's offset position.
| UIMapControl | ||
| owner : IMapObjectContainer
[read-only]
Returns reference to the owner container object.
| UIMapControl | ||
| padding : Point
Gets or sets the control's padding value.
| UIMapControl | ||
| stackAlignment : String
Gets or sets control's stack alignment.
| UIMapControl | ||
| STACK_HORIZONTAL : String = "horizontal" [static]
| UIMapControl | ||
| stackPadding : Point
Gets or sets control's stack padding value.
| UIMapControl | ||
| STACK_VERTICAL : String = "vertical" [static]
| UIMapControl | ||
| Method | Defined by | ||
|---|---|---|---|
|
UIMapControl(param:Object = null)
| UIMapControl | ||
|
cancelDoubleClick(event:MouseEvent = null):void
| UIMapControl | ||
|
cancelDragging(event:MouseEvent = null):void
| UIMapControl | ||
|
dispose():void
Releases all the resources accuired by the object.
| UIMapControl | ||
| UIMapControl | |||
|
init():void
Invoked when control has been attached to GuiManager, or when UMap has been initialized.
| UIMapControl | ||
|
ready():void
Invoked when UMap enters ready() state.
| UIMapControl | ||
|
refresh():void
Refreshes the control.
| UIMapControl | ||
|
remove():void
Removes the object from the owner container object.
| UIMapControl | ||
|
setAvailableSize(size:Size):void
Invoked by GuiManager to report the available space this control can occupy.
| UIMapControl | ||
|
setOwner(owner:IMapObjectContainer):void
Adds the object to the specified IMapObjectContainer.
| UIMapControl | ||
|
setRefreshCallback(refresh:Function):void
Sets the callback function which should be called by the control after it's size has been updated.
| UIMapControl | ||
|
updateMapType(mapType:IMapType):void
Invoked when map type has been updated.
| UIMapControl | ||
|
updatePosition(latlng:LatLng):void
Invoked when map center has been updated.
| UIMapControl | ||
|
updateSize(width:Number, height:Number):void
Invoked when the UMap Component size has been updated.
| UIMapControl | ||
|
updateZoom(zoom:Number):void
Invoked when map zoom level has been updated.
| UIMapControl | ||
| Method | Defined by | ||
|---|---|---|---|
|
createChildren():void
| UIMapControl | ||
| align | property |
align:Align [read-write]
Gets or sets the control's alignment. Use Align constants.
public function get align():Align
public function set align(value:Align):void
| asDisplayObject | property |
asDisplayObject:DisplayObject [read-only]Returns reference to the object as a DisplayObject instance.
Implementation public function get asDisplayObject():DisplayObject
| core | property |
core:UMap [read-only]Returns reference to the core UMap object.
Implementation public function get core():UMap
| display | property |
display:String [read-write]Implementation
public function get display():String
public function set display(value:String):void
| DISPLAY_COMPACT | property |
public static var DISPLAY_COMPACT:String = "compact"
| DISPLAY_EXPANDED | property |
public static var DISPLAY_EXPANDED:String = "expanded"
| id | property |
id:uint [read-write]Gets or sets the ID of the object.
Implementation public function get id():uint
public function set id(value:uint):void
| minSize | property |
minSize:Size [read-write]Gets or sets control's minimum size.
Implementation public function get minSize():Size
public function set minSize(value:Size):void
| name | property |
name:String [read-write]Implementation
public function get name():String
public function set name(value:String):void
| offset | property |
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
| owner | property |
owner:IMapObjectContainer [read-only]Returns reference to the owner container object.
Implementation public function get owner():IMapObjectContainer
| padding | property |
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
| stackAlignment | property |
stackAlignment:String [read-write]
Gets or sets control's stack alignment.
Can be either MapControl.STACK_VERTICAL or MapControl.STACK_HORIZONTAL.
public function get stackAlignment():String
public function set stackAlignment(value:String):void
| STACK_HORIZONTAL | property |
public static var STACK_HORIZONTAL:String = "horizontal"
| stackPadding | property |
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
| STACK_VERTICAL | property |
public static var STACK_VERTICAL:String = "vertical"
| UIMapControl | () | constructor |
public function UIMapControl(param:Object = null)Parameters
param:Object (default = null) |
| cancelDoubleClick | () | method |
public function cancelDoubleClick(event:MouseEvent = null):voidParameters
event:MouseEvent (default = null) |
| cancelDragging | () | method |
public function cancelDragging(event:MouseEvent = null):voidParameters
event:MouseEvent (default = null) |
| createChildren | () | method |
protected function createChildren():void
| dispose | () | method |
public function dispose():voidReleases all the resources accuired by the object.
| getBoundsXY | () | method |
| init | () | method |
public function init():voidInvoked when control has been attached to GuiManager, or when UMap has been initialized.
| ready | () | method |
public function ready():voidInvoked when UMap enters ready() state.
| refresh | () | method |
public function refresh():voidRefreshes the control.
| remove | () | method |
public function remove():voidRemoves the object from the owner container object.
| setAvailableSize | () | method |
public function setAvailableSize(size:Size):voidInvoked by GuiManager to report the available space this control can occupy.
Parameterssize:Size — Dimensions of the available space.
|
| setOwner | () | method |
public function setOwner(owner:IMapObjectContainer):voidAdds the object to the specified IMapObjectContainer.
If the object was previosly attached to a container, object will be removed from it.
If you specify null instead of the owner, IllegalOperationError will be thrown.
owner:IMapObjectContainer — New owner of the object.
|
| setRefreshCallback | () | method |
public function setRefreshCallback(refresh:Function):voidSets 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.
Parametersrefresh:Function |
| updateMapType | () | method |
public function updateMapType(mapType:IMapType):voidInvoked when map type has been updated.
ParametersmapType:IMapType — Reference to the new map type.
|
| updatePosition | () | method |
public function updatePosition(latlng:LatLng):voidInvoked when map center has been updated.
Parameterslatlng:LatLng — Geographical coordinates of the new map center.
|
| updateSize | () | method |
public function updateSize(width:Number, height:Number):voidInvoked when the UMap Component size has been updated.
Parameterswidth:Number — New width of the component.
|
|
height:Number — New height of the component.
|
| updateZoom | () | method |
public function updateZoom(zoom:Number):voidInvoked when map zoom level has been updated.
Parameterszoom:Number — New zoom level.
|