Package | com.google.maps.overlays |
Class | public class OverlayBase |
Inheritance | OverlayBase ![]() |
Implements | flash.events.IEventDispatcher, IOverlay |
Property | Defined by | ||
---|---|---|---|
foreground : DisplayObject [read-only]
Display object that represents the overlay's foreground content.
| OverlayBase | ||
pane : IPane
The pane this overlay resides on.
| OverlayBase | ||
shadow : DisplayObject [read-only]
Display object that represents the overlay's shadow.
| OverlayBase | ||
visible : Boolean
Visibility of the overlay.
| OverlayBase |
Method | Defined by | ||
---|---|---|---|
Constructor.
| OverlayBase | ||
Determines the pane that the overlay is placed on when it is added
to the map through the Map.addOverlay() call.
This method must be overloaded for the Map.addOverlay() call to function correctly. | OverlayBase | ||
positionOverlay(zoomChanged:Boolean):void
Reposition the overlay on the screen.
| OverlayBase |
Method | Defined by | ||
---|---|---|---|
clearWrapper():void
Remove all event listeners and clear the wrapper.
| OverlayBase |
foreground | property |
foreground:DisplayObject
[read-only]Display object that represents the overlay's foreground content.
Implementation public function get foreground():DisplayObject
pane | property |
pane:IPane
[read-write]The pane this overlay resides on. The pane is set when the overlay is added to the map. Developers may override the "set pane" method to handle addition/removal of the overlay to/from the map. Alternatively, developers map add listeners for MapEvent.OVERLAY_ADDED and MapEvent.OVERLAY_REMOVED events on the overlay to handle addition and removal of the overlay to/from the map.
Implementation public function get pane():IPane
public function set pane(value:IPane):void
shadow | property |
shadow:DisplayObject
[read-only]Display object that represents the overlay's shadow. By default returns null (no shadow). If the overlay needs to have a shadow, this method property should be redefined and the value of shadow set before the overlay is added to the map. The display object returned by this property should remain unchanged while the overlay is added to a map.
Implementation public function get shadow():DisplayObject
visible | property |
visible:Boolean
[read-write]Visibility of the overlay.
Implementation public function get visible():Boolean
public function set visible(value:Boolean):void
OverlayBase | () | constructor |
public function OverlayBase()
Constructor.
clearWrapper | () | method |
protected function clearWrapper():void
Remove all event listeners and clear the wrapper.
getDefaultPane | () | method |
public function getDefaultPane(map:IMap):IPane
Determines the pane that the overlay is placed on when it is added
to the map through the Map.addOverlay() call.
This method must be overloaded for the Map.addOverlay() call to
function correctly. It is not required if the overlay is always
added directly to its pane using IPane.addOverlay() call.
map:IMap — Instance of map that this overlay is added to.
|
IPane —
Instance of IPane to which the overlay will be added by default.
|
positionOverlay | () | method |
public function positionOverlay(zoomChanged:Boolean):void
Reposition the overlay on the screen. This method is called in response to changes in the position (centre) of the map and/or the map's zoom level. Developers should not call the method themselves. The implementation of this method should either change the position of the overlay on the screen in response to the change of the map's centre or redraw the overlay completely if it needs to be reconfigured for a different map centre/zoom level. Repositioning of the overlay should be done by changing the placement of the overlay's display object on its pane using the mappings provided by the IPane interface (fromLatLngToPaneCoords or fromProjectionPointToPaneCoords). This method is not implemented in the default implementation and must be overloaded in the derived classes to function properly.
ParameterszoomChanged:Boolean — Whether the zoom level of the map has changed
or the call was invoked just as a result of a map pan.
|