Class Index | File Index

Classes


Class adf.MapCallout


Extends adf.Callout.

Defined in: Map.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
This implementation of adf.Callout has specific logic pertaining to placement on an adf.Map.
Field Summary
Field Attributes Field Name and Description
 
map
The adf.Map object which will contain this adf.MapCallout.
 
Boolean value that when set to true, this adf.MapCallout will automatically reposition itself in the correct place on the map after an adf.Map.onZoom event.
Fields borrowed from class adf.Callout:
dontAnimate, fadeDuration, height, layoutClass, maxHeight, maxWidth, sizeDuration, themeClass, width, zIndex
Fields borrowed from class adf.PageElement:
bounds, divId, divObject, id
Method Summary
Method Attributes Method Name and Description
 
Overrides the default implementation so that the position of the callout is determined by the visible area of the map rather than the map's imageGrid element.
 
Overrides the default implementation in order to provide the height and width of the adf.Map bound to this widget.
 
moveTo(mapPoint, pixelOffset)
Moves the anchor point of the callout to the coordinates specified (with respect to its containing element).
Methods borrowed from class adf.Callout:
collapse, createDom, expand, fit, getAnchorPosition, getContent, hide, init, isCollapsed, isVisible, loadSpriteOffsets, setContent, setThemeClass, show, toggle
Methods borrowed from class adf.PageElement:
resize
Event Summary
Event Attributes Event Name and Description
 
afterMove(mapPoint, pixelOffset)
Overrides the default adf.Callout.afterMove().
Events borrowed from class adf.Callout:
beforeMove, onCollapse, onContentChange, onDismiss, onExpand, onHide, onShow, onThemeChange
Class Detail
adf.MapCallout(args)
This implementation of adf.Callout has specific logic pertaining to placement on an adf.Map. This also takes into account the following adf.Map events that affect how a adf.Callout is displayed ({@adf.Map.onZoom}, {@adf.Map.onResize} and {@adf.Map.onExtentChange}).
See documentation for adf.Callout for base constructor arguments.
Parameters:
{adf.Map} args.map
The adf.Map this callout is bound to
args
Field Detail
{adf.Map} map
The adf.Map object which will contain this adf.MapCallout.

updateOnMapZoom
Boolean value that when set to true, this adf.MapCallout will automatically reposition itself in the correct place on the map after an adf.Map.onZoom event.
Method Detail
getCalloutPosition()
Overrides the default implementation so that the position of the callout is determined by the visible area of the map rather than the map's imageGrid element.

getContainerDimensions()
Overrides the default implementation in order to provide the height and width of the adf.Map bound to this widget. This helps the callout determine the proper display orientation since.

moveTo(mapPoint, pixelOffset)
Moves the anchor point of the callout to the coordinates specified (with respect to its containing element). The orientation/layout of the anchor point will be adjusted as needed.
Parameters:
{adf.Point} mapPoint
the new position of callout in map coordinates
{adf.Point} pixelOffset
the desired offset, in pixels
Event Detail
afterMove(mapPoint, pixelOffset)
Overrides the default adf.Callout.afterMove(). This implementation of the event is different in only that it passes the location of the Callout as a map coordinate.
Parameters:
{adf.Point} mapPoint
{adf.Point} pixelOffset

Documentation generated by JsDoc Toolkit 2.1.0 on Mon May 17 2010 13:45:42 GMT-0700 (PDT)