Class Index | File Index

Classes


Class adf.EditingState


Extends adf.ToolItemCollection.

Defined in: EditTask.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
adf.EditingState(id, mapId)
This Class extends adf.ToolItemCollection for maintaining state of the partial edited featues on the client during map operations.
Field Summary
Field Attributes Field Name and Description
 
The graphics container used by the EditingState to draw the Editing faetures
 
id
The id of EditingState
 
The last tool item of the EditingState Object
 
The parameter to prompt when partial edited geometery is cleared
Method Summary
Method Attributes Method Name and Description
 
addPoint(pt, isMap)
adds the digitized point from the EditingToolItem to the EditingState
 
The method clears the current toolitem of the EditingState Collection This method differs from adf.EditingState#resetToolItem, Not only the state is cleared in the Editing State , the adf.EditingState#lastToolITem is set to null.
 
This method clears the state of the EditingState, clears the stored geometry and the graphics, the currentToolitem is reset and set back again
 
The method prompts for confirmation when partial digitized geomtery are getting cleared
 
createToolItem(id, eId, clientAction, showLoading, postBack, lineColor, lineWidth, default, hover, select, disabled)
This method creates the editing tool item that is added to this EditingState Collection
 
This method deactivates the current toolitem of the EditingState Collection It clears the toolitem adf.EditingState#lastToolItem's state and graphics created so far and deactivates the current Toolitem
 
This Method gets the first and last digitized points in screen coordinates for the current extent.
 
This getter method is to get the Map Geometery of the digitized geometery
 
The getter method for prompt messages to alert when the partial editing features is getting cleared
 
This getter method is to get the Screen Geometery of the digitized geometery
 
resetToolItem(toolId)
This method resets the current toolitem of the EditingState Collection It clears the toolitem adf.EditingState#lastToolItem's state and graphics created so far and starts again.
 
This method sets the current toolitem of the EditingState Collection
Class Detail
adf.EditingState(id, mapId)
This Class extends adf.ToolItemCollection for maintaining state of the partial edited featues on the client during map operations. By setting collectionId attribute in JSF Button Tag a ToolItem can be added to this collection a:button id="addPolyline" mapId="map1" collectionId="E1" clientAction="adf.EditingPolyline" At any point, only one ToolItem in this collection can store its partial edited state information, if the other toolitem in this collection wnats to store its state, it has to reset the previous toolitem to store its state. The User prompted for confirmation when the current toolitem is reset.
Parameters:
{String} id
id for this collection object
{String} mapId
the map Id this editing task is configured to
Field Detail
{adf.GraphicsElement} graphics
The graphics container used by the EditingState to draw the Editing faetures

{String} id
The id of EditingState
Default Value:
"E1"

{adf.EditingToolItem} lastToolItem
The last tool item of the EditingState Object

{Boolean} prompt
The parameter to prompt when partial edited geometery is cleared
Method Detail
addPoint(pt, isMap)
adds the digitized point from the EditingToolItem to the EditingState
Parameters:
{adf.Point} pt
{Boolean} isMap

clearCurrentToolItem()
The method clears the current toolitem of the EditingState Collection This method differs from adf.EditingState#resetToolItem, Not only the state is cleared in the Editing State , the adf.EditingState#lastToolITem is set to null. At this stage, adf.EditingState has no toolitem's set as the current ToolItem

clearState()
This method clears the state of the EditingState, clears the stored geometry and the graphics, the currentToolitem is reset and set back again

confirmClear()
The method prompts for confirmation when partial digitized geomtery are getting cleared

createToolItem(id, eId, clientAction, showLoading, postBack, lineColor, lineWidth, default, hover, select, disabled)
This method creates the editing tool item that is added to this EditingState Collection
Parameters:
id
{adf.Map} The EditingToolItem's id
{String} eId
The Element of the EditingToolItem is configured to
{String} clientAction
The name of the ClientAction of the EditingToolItem is configured to
{Boolean} showLoading
Whether To Show the Loading Image
{Boolean} postBack
whether to submit request through AJAX postback
{String} lineColor
lineColor of the graphic symbol used by the tool item's action
{Number} lineWidth
width of the graphic symbol used by the tool item's action
{String} default
defaultImage when the ToolItem is displayed
{String} hover
hoverImage when mouse is hoverd over the toolitem
{String} select
This image is shown when the toolitem is selected
{String} disabled
This image is diplayed when the toolitem is disabled

deactivateToolItem(toolId)
This method deactivates the current toolitem of the EditingState Collection It clears the toolitem adf.EditingState#lastToolItem's state and graphics created so far and deactivates the current Toolitem
Parameters:
toolId
id of the EditingToolItem that is in this collection

getFirstAndLastPoints()
This Method gets the first and last digitized points in screen coordinates for the current extent. As an illustartion, The user is using Create Polyline ToolItem to create a road gemetry and digitized three points, zooms in to see the digitized points, pans the map, By invoking this method the user will get the firstandlastpoints of this polyline in the current screen coordinates. Its used more as a convenience method for EditingToolItem to continue the digitisation where it wa left before these map actions occured.Editing ToolItem's continuousCallback invoked this method to continue the digitizing process where it was left when Map Event occured, For example usage See adf.EditingPoly#continuousAction

getMapGeometry()
This getter method is to get the Map Geometery of the digitized geometery

getPrompt()
The getter method for prompt messages to alert when the partial editing features is getting cleared

getScreenGeometry()
This getter method is to get the Screen Geometery of the digitized geometery

resetToolItem(toolId)
This method resets the current toolitem of the EditingState Collection It clears the toolitem adf.EditingState#lastToolItem's state and graphics created so far and starts again.
Parameters:
{String} toolId
id of the EditingToolItem that is in this collection

setCurrentToolItem(toolId)
This method sets the current toolitem of the EditingState Collection
Parameters:
{String} toolId
id of the EditingToolItem that is in this collection

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