| SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An interface which has to be implemented by all overlays. Overlays are displayed behind the controls.
Author: JAN| Constructor Summary | |
IWOverlay(map, coordinate)
Overlay interface. |
|
| Method Summary | |
void
|
afterAppend()
Callback method. This method will be directly called by the addOverlay method after the overlay has been added to
the map.
|
void
|
afterRemove()
Callback method. This method will be directly called by the removeOverlay method after the overlay has been removed
from the map.
|
void
|
beforeAppend()
Callback method. This method will be directly called by the addOverlay method before the overlay has been added to
the map.
|
void
|
beforeRemove()
Callback method. This method will be directly called by the removeOverlay method before the overlay has been
removed from the map.
|
void
|
destroyOverlay()
Destroys the overlay. |
IWCoordinate
|
getCoordinate()
Returns the coordinate for this overlay. |
IWPoint
|
getHotspot()
Returns the hotspot of the container object. |
int
|
getLayer()
Returns the layer number of this overlay. calling the addOverlay() method from the IWOverlayLayer.
|
void
|
redraw()
Redraws the overlay. Calculates and sets the new pixel position where the overlay appears on the map. |
void
|
setCoordinate(newCoordinate)
Sets the coordinate for this overlay. |
void
|
setHotspot(newHotspot)
Sets the hotspot of the container object. |
| Event Summary | |
void
|
triggerOnPositionChange()
The onPositionChange event is fired after the coordinate of the overlay object has been changed. Register an event listener with IWEventManager.addListener(overlayObject, 'onpositionchange', yourHandlerMethod(event)); to receive this event. |
void
|
triggerOnRedrawEnd()
The onRedrawEnd event is fired after the overlay has been redrawed. Register an event listener with IWEventManager.addListener(overlayObject, 'onredrawend', yourHandlerMethod()); to receive this event. Notice that no event object will be passed through the handler method. |
void
|
triggerOnRedrawStart()
The onRedrawStart event is fired before the overlay is redrawed. Register an event listener with IWEventManager.addListener(overlayObject, 'onredrawstart', yourHandlerMethod()); to receive this event. Notice that no event object will be passed through the handler method. |
| Methods inherited from class IWDraggable |
| allowDraggingOutsideParent(isDraggingOutsideParentAllowed) |
| isDraggingOutsideParentAllowed() |
| setOnMouseMoveContainer(container) |
| getOnMouseMoveContainer() |
| setDraggingBounds(bounds) |
| getDraggingBounds() |
| setDraggable(isDraggable) |
| isDraggable() |
| setDraggableContainer(draggableContainer) |
| getDraggableContainer() |
| setDragButton(button) |
| getDragButton() |
| Methods inherited from class IWMapElement |
| isDisplayed() |
| getParent() |
| setParent(newParent) |
| isVisible() |
| setVisible(visible) |
| setPrintable(printable) |
| isPrintable() |
| setContainerClassname(classname) |
| getContainer() |
| setContainer(newContainer) |
| setId(id) |
| getId() |
| onContextMenu(event) |
| onMouseUp(event) |
| onMouseDown(event) |
| onMouseMove(event) |
| onMouseOut(event) |
| onMouseOver(event) |
| onClick(event) |
| onDblClick(event) |
| onSelect(event) |
| onMouseWheel(event) |
| destroyMapElement() |
| Constructor Detail |
IWOverlay(map, coordinate)
IWMap map - the map on which the overlay appears.
IWCoordinate coordinate - the coordinate
| Method Detail |
void afterAppend()
addOverlay method after the overlay has been added to
the map. Overwrite this method to react on this event.
void
void afterRemove()
removeOverlay method after the overlay has been removed
from the map. Overwrite this method to react on this event.
void
void beforeAppend()
addOverlay method before the overlay has been added to
the map. Overwrite this method to react on this event.
void
void beforeRemove()
removeOverlay method before the overlay has been
removed from the map. Overwrite this method to react on this event.
void
void destroyOverlay()
void
IWCoordinate getCoordinate()
IWCoordinate
IWPoint getHotspot()
IWPoint
int getLayer()
addOverlay() method from the IWOverlayLayer.
int the layer number
void redraw()
void
void setCoordinate(newCoordinate)
IWCoordinate newCoordinate
void
void setHotspot(newHotspot)
IWPoint newHotspot
void
| Event Detail |
void triggerOnPositionChange()
Register an event listener with IWEventManager.addListener(overlayObject, 'onpositionchange', yourHandlerMethod(event)); to receive this event.
void
void triggerOnRedrawEnd()
Register an event listener with IWEventManager.addListener(overlayObject, 'onredrawend', yourHandlerMethod()); to receive this event.
Notice that no event object will be passed through the handler method.
void
void triggerOnRedrawStart()
Register an event listener with IWEventManager.addListener(overlayObject, 'onredrawstart', yourHandlerMethod()); to receive this event.
Notice that no event object will be passed through the handler method.
void