Class adf.MapRectangle

Extends adf.MapToolItem.

Defined in: MapToolItem.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	adf.MapRectangle(id, name, action, isMarker) This ToolItem uses adf.DrawRectangleAction to draw a rectangle on the adf.Map.

Field Summary
Field Attributes	Field Name and Description
	action The adf.action associated with the ToolItem
	id The id of the ToolItem
	isMarker Whether tool item is a marker (drawn as graphic on screen) or tool (sends coordinates/request to server)
	name The name of the ToolItem

Fields borrowed from class adf.MapToolItem:: blockMapPan, blockMapZoom, control
Fields borrowed from class adf.ToolItem:: clientPostBack, defaultImage, defaultStyle, disabledImage, disabledStyle, element, hoverImage, hoverStyle, isActive, isCommand, isDisabled, selectedImage, selectedStyle, showLoading, toolTip

Method Summary
Method Attributes	Method Name and Description
	activate() Activates this adf.MapRectangle tool item
	deactivate() Deactivates the ToolItem by deactivating its action
	postAction(rect) This callback is called after adf.DrawRectangleAction is completed.

Class Detail

adf.MapRectangle(id, name, action, isMarker)

This ToolItem uses adf.DrawRectangleAction to draw a rectangle on the adf.Map. It sends back both screen and map coordinates of the rectangle to the web server. The adf.ToolItem#clientPostBack determines whether the request to the web server will be sent through partial postback (AJAX) or full postback.

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

{adf.Action} action

The adf.action associated with the ToolItem

Default Value:: adf.DrawRectangleAction

{String} id

The id of the ToolItem

{Boolean} isMarker

Whether tool item is a marker (drawn as graphic on screen) or tool (sends coordinates/request to server)

{String} name

The name of the ToolItem

Method Detail

activate()

Activates this adf.MapRectangle tool item

deactivate()

Deactivates the ToolItem by deactivating its action

postAction(rect)

This callback is called after adf.DrawRectangleAction is completed.

Parameters:
{adf.Rectangle} rect

Classes

Class adf.MapRectangle