Class adf.MapToolItem
Extends
adf.ToolItem.
Defined in: MapToolItem.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
adf.MapToolItem(id, name, action, isMarker)
All adf.ToolItems that work with the adf.Map extend this class.
|
| Field Attributes | Field Name and Description |
|---|---|
|
when true, the map will ignore any pan operations
|
|
|
when true, the map will ignore any zoom operations
|
|
|
Contains a reference to this adf.MapToolItem's map control(adf.Map).
|
- Fields borrowed from class adf.ToolItem:
- action, clientPostBack, defaultImage, defaultStyle, disabledImage, disabledStyle, element, hoverImage, hoverStyle, id, isActive, isCommand, isDisabled, isMarker, name, selectedImage, selectedStyle, showLoading, toolTip
| Method Attributes | Method Name and Description |
|---|---|
|
activate()
Activates the ToolItem by activating its associated Actionadf.ToolItem#action
|
|
|
Deactivates the ToolItem by deactivating its action
|
|
|
The callback function to call after a adf.ToolItem's adf.Action is completed
|
Class Detail
adf.MapToolItem(id, name, action, isMarker)
All adf.ToolItems that work with the adf.Map extend this class.
- Parameters:
- {String} id
- the id of the tool
- {String} name
- the name of the tool
- {adf.Action} action
- the adf.Action bound to this tool
- {Boolean} isMarker Optional, Default: false
- This parameter has been deprecated.
Field Detail
{Boolean}
blockMapPan
when true, the map will ignore any pan operations
- Default Value:
- false
{Boolean}
blockMapZoom
when true, the map will ignore any zoom operations
- Default Value:
- false
control
Contains a reference to this adf.MapToolItem's map control(adf.Map).
Method Detail
activate()
Activates the ToolItem by activating its associated Actionadf.ToolItem#action
deactivate()
Deactivates the ToolItem by deactivating its action
postAction()
The callback function to call after a adf.ToolItem's adf.Action is completed