Class adf.ToolItemCollection

Defined in: core.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	adf.ToolItemCollection(id, mapId) This is a base class for creating Collection of ToolItems which need to goruped together to accomplish a business case scenario.

Method Summary
Method Attributes	Method Name and Description
	clearCurrentToolItem(toolId) This method sets the current toolitem of the ToolItem Collection.
	createToolItem(id, eId, clientAction, showLoading, postBack, lineColor, lineWidth, default, hover, select, disabled, toolCollection) This base method is create a toolitem for this collection.
	deactivateToolItem(toolId) Deactivates the tool item with the specified id.
	resetToolItem(toolId) This method resets the current toolitem of the EditingState Collection It is used to clear the toolitem state in the collection so far and starts the state again.
	setCurrentToolItem(toolId) Sets the tool with the specified id to be active

Class Detail

adf.ToolItemCollection(id, mapId)

This is a base class for creating Collection of ToolItems which need to goruped together to accomplish a business case scenario. It defines set of methods that needs to be implement as per the method semantoc definitions by the class extending this toolitem One Such Implementation available out-of-box is adf.EditingState Collection Editing ToolItems

Parameters:
id: {String} the collection id
mapId: {String} the id of the map this collection of tools is bound to

Method Detail

clearCurrentToolItem(toolId)

This method sets the current toolitem of the ToolItem Collection. Its an empty implemenattion This method semantically differs from adf.ToolItemCollection#resetToolItem, Not only the toolitem is cleared in the ToolItemCollection, At this stage, adf.ToolItemCollection has no toolitem's set as the current ToolItem .

Parameters:
{String} toolId

createToolItem(id, eId, clientAction, showLoading, postBack, lineColor, lineWidth, default, hover, select, disabled, toolCollection)

This base method is create a toolitem for this collection. Its an empty implementation

Parameters:
id: {adf.Map} The ToolItem's id
eId: The Element of the ToolItem is configured to
clientAction: The name of the ClientAction of the ToolItem is configured to
showLoading: Whether To Show the Loading Image
postBack: whether to submit request through AJAX postback
lineColor: lineColor of the graphic symbol used by the tool item's action
lineWidth: width of the graphic symbol used by the tool item's action
default: defaultImage when the ToolItem is displayed
hover: hoverImage when mouse is hoverd over the toolitem
select: This image is shown when the toolitem is selected
disabled: This image is diplayed when the toolitem is disabled
toolCollection

deactivateToolItem(toolId)

Deactivates the tool item with the specified id.

Parameters:
{String} toolId: the id of the tool to deactivate

resetToolItem(toolId)

This method resets the current toolitem of the EditingState Collection It is used to clear the toolitem state in the collection so far and starts the state again.

Parameters:
{String} toolId

setCurrentToolItem(toolId)

Sets the tool with the specified id to be active

Parameters:
{String} toolId: the id of the tool to activate

Classes

Class adf.ToolItemCollection