Class adf.EditTaskSettings

Defined in: EditTask.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	adf.EditTaskSettings() This Class defines the configuration properties and methods of the Editing Task UI.

Field Summary
Field Attributes	Field Name and Description
	addFeaturesDivId This is the id of the add features Features Toolbar.
	clearSketchIds The array of clearsketch tool ids configured for the Editing Task
	editAttributesDivId This is the id of the Editing Attributes Features Toolbar.
	editDivId The container div id of the Editing Task
	editFeaturesDivId This is the id of the Editing Features Toolbar.
	editorNullFeatureMessage The Status Message when the Features is not selected on the Editing Task Window
	editorSettingsWin The Edit Task Settings window
	editorVersionWin The Edit Task Version window
	editorWin The Editor Window UI
	editorWindowClosed This value is true when the Edit Task Window is closed
	editorWindowsRefreshId The editor window refresh id of the Editing Task
	editorWindowTitle The Title of the Editing Task Window
	editorXYWin The Edit Task XY window
	editSnappingRulesDiv The snapping rules div id on the editing window
	editVersionDivId The container div id of edit version window in the Editing Task
	formId The formid of the page used in sending partial and full postback requests
	mapId The id of the adf.Map this task is configured to
	selectEditLayerId The selectbox input's id of the Editing Task
	selectEditVersionId The select edit version window id
	selectedLayer The Selected Layer on the Editing Task Window
	settingsDivId The settings div id on the editing window
	settingsLinkId The settings link id on the editing window
	silentClearSketch This parameter when configured to true clears the partial digitized geometery without alerting user with prompts This is set in the faces-config.xml
	snapColorId The snapping color id on the editing window
	snapEnabledId The snapping enabled id on the editing window
	snapRequestInterval This property sets the snapping request time interval in milliseconds for every editing tool that uses snapping.
	snapTolId The snapping tool id on the editing window
	snapWidth The Snapping width configured for the Editing Task
	xyDivId The container div id the xy editing window

Method Summary
Method Attributes	Method Name and Description
	attributesUpdateHandler(xml) This method renders the attribute table and updates the contents of this attribute table during Editing task updates.
	clearEditSketch(collid) This method clears partial dijitized geometry based on the collection id.
	closeEditorWindowHandler(win) This event handler is called when the adf.EditTaskSettings#editorWin event adf.Window#event:onCancel occurs.
	closeEditorWindowRequest(action) This sends the AJAX request when the window is closed.
	configBeanHandler(xml) This method sets the Configuration of the Editing Task based on the Config Bean, if it was defined when the task was created.
	createEditWindow(formId, editDivId) This method creates a new Editing Window
	createSettingsWindow(formId, settingsDivId) This method creates a new Settings Window
	createVersionWindow(formId, editVersionDivId) This method creates a new Version Window
	createXYWindow(formId, settingsDivId) This method creates a new XY Window
	deactivateEditSketch(collid) This method deactivates the Editing State adf.editingState's current ToolItem and the disbales the clearEditSkect Tool This parameter maps to collectionId attribute in JSF Button Tag a `a:button id="addPolyline" mapId="map1" collectionId="E1" clientAction="adf.EditingPolyline"`
	editBeanHandler(xml) This Ajax response handler does most of the business logic needed for Editor Task Window UI which depend on the synchronized state on the server and the client during the Editing Workflows For example these UI updates are handled by this method This Method is invoked on every postback to the server.
	editorEnterXYWindowHandler(xml, eventsource) Process postback xml response XY Window request
	editorExitWindowHandler(xml, action) This AJAX handler called when window is exited It does the post-processing from the server side when the close window event occurs.
	editorShowWindowHandler(xml, eventsource, action) This the AJAX response handler for showing window details
	enableClearSketch(enable, collid) This method enables/diables the clearsketch tool of particulator toolitem collection The clearskecth is enabled when there is partial digitized geometry and diabled when there is not
	enterXYRequest(eventSource, xID, yID) This sends AJAX request method is to enter the XY values
	getCollectionId(eId) This method returns the collectionID for a DOM Element This collection id identifies the adf.editingState the Editing Tool belongs to
	initEditor() Initializes the Editing Task It creates the version, settings, edit and xy windows for the editing task.
	initEditorRequest(action) This method sends AJAX request during Editing Task window initialization to get the details and also when the Edit Task window is displayed
	newXYWindowRequest(clientAction, serverAction) This sends the new XY window request to initialize the setting for XY Window
	refreshEditor() This method refreshes the Editing Task
	refreshEditorRequest(action, eventSource) This method sends AJAX request to Start Editing, it is invoked by clicking Start Editing Button in Version Window
	refreshVersionsRequest(configName) This method sends an AJAX request to the server when the editing configuration is changed in the version window
	resetLayer() This event listener is invoked when the Editing Task Select Layer onChange event is fired.
	sessionButtonsHandle(xml) This handler updates the state of the Session Buutons Ui on the Editor Task Window.
	showAttributesIndex(selected) This method provides paged view of attributes Table based on preOID,firstOID,nextOID,lastOID
	showEditorWindow() This method Shows the Editing Task, it sends an AJAX request to the server informing the EditBean about this action through adf.EditTaskSettings#initEditorRequest method.
	showEnterXYWindow() This shows the XY window for entering X, Y map coordinate values through text box rather than drawing them on the map It sends an AJAX request to the server to initialize the settings required for this window by invoking adf.EdiTaskSettings#showEnterXYWindow
	showLayerList(xml) This method Creates the selection input box for showing different layers and registers the events listeners for this DOM.
	showSelectedAttributes(xml, attsDiv) show the attributes in the currented selected view , The attributes table provides a pageable view to the user, The selected attribute in the current selected page is shown through this method
	showSnapRules(rulesDiv, xml) This Method sets the snapping rules for this editing task.
	storeSelectedLayer() This method stores the selected layer into adf.EditTaskSettings#selectedLayer
	updateAttributeRequest(id, value) This method sends an AJAX request when the value of the attribute is updated/changed.
	updateEditorResponse(xmlHttp, response, requestParams) This is a Centralized AJAX Response handler for all the Editor Task AJAX request sent by adf.EditTaskSettings#initEditorRequest, adf.EditTaskSettings#refreshEditorRequest , adf.EditTaskSettings#updateAttributeRequest , adf.EditTaskSettings#closeEditorWindowRequest This method filters the response then calls the specific methods which handles the responses pertaining to its task.
	updateSettingsRequest(name, value, layer) This method sends an AJAX request when the value of the settings attributes is changed like snapping rules, snap Tolerance.
	updateSnapRules(xmlHttp, response) This method handles the AJAX response when the snaprules are updated
	updateSnapStatus(xml) This Method is used for dyanmically updating the snapping rules when the Editing Task is being used.
	versionWindowHandler(xml) This handler sets up the settings sent by the server for the version window

Class Detail

adf.EditTaskSettings()

This Class defines the configuration properties and methods of the Editing Task UI. The EditTask Window, Settings Window, Version Window are initialized and configured by this class. This class has an only one instance available through the object adf.EditTask out of the box. Users can modify the properties of this object to re-configure the look and feel of the out of the box editing task Also, users can extend this class to create their own Editing Task UI according to their needs

Field Detail

{String} addFeaturesDivId

This is the id of the add features Features Toolbar. All these tools are added to this Div

Default Value:: addFeaturesDivId

{Array} clearSketchIds

The array of clearsketch tool ids configured for the Editing Task

Default Value:: ["clearsketch"]

{String} editAttributesDivId

This is the id of the Editing Attributes Features Toolbar. All these tools are added to this Div

Default Value:: editAttributesDivId

{String} editDivId

The container div id of the Editing Task

Default Value:: "esri_editDiv"

{String} editFeaturesDivId

This is the id of the Editing Features Toolbar. All these tools are added to this Div

Default Value:: editFeaturesDivId

{String} editorNullFeatureMessage

The Status Message when the Features is not selected on the Editing Task Window

Default Value:: No features selected

{adf.Window} editorSettingsWin

The Edit Task Settings window

{adf.Window} editorVersionWin

The Edit Task Version window

{adf.Window} editorWin

The Editor Window UI

{Boolean} editorWindowClosed

This value is true when the Edit Task Window is closed

{String} editorWindowsRefreshId

The editor window refresh id of the Editing Task

Default Value:: "editorWindowsRefreshId"

{String} editorWindowTitle

The Title of the Editing Task Window

Default Value:: Editing

{adf.Window} editorXYWin

The Edit Task XY window

{String} editSnappingRulesDiv

The snapping rules div id on the editing window

Default Value:: editSnappingRulesDiv

{String} editVersionDivId

The container div id of edit version window in the Editing Task

Default Value:: esri_editVersionDiv

{String} formId

The formid of the page used in sending partial and full postback requests

Default Value:: "mapForm"

{String} mapId

The id of the adf.Map this task is configured to

Default Value:: "map1"

{String} selectEditLayerId

The selectbox input's id of the Editing Task

Default Value:: "selectEditLayerId"

{String} selectEditVersionId

The select edit version window id

Default Value:: mapForm:editVersionSubview:selectEditVersionId

selectedLayer

The Selected Layer on the Editing Task Window

{String} settingsDivId

The settings div id on the editing window

Default Value:: esri_editSettingsDiv

{String} settingsLinkId

The settings link id on the editing window

Default Value:: settingsLinkId

{Boolean} silentClearSketch

This parameter when configured to true clears the partial digitized geometery without alerting user with prompts This is set in the faces-config.xml

{String} snapColorId

The snapping color id on the editing window

Default Value:: editconfig_snapTipsColor

{String} snapEnabledId

The snapping enabled id on the editing window

Default Value:: editconfig_snapEnabled

snapRequestInterval

This property sets the snapping request time interval in milliseconds for every editing tool that uses snapping. A Snap Request is sent after this interval of time

Default Value:: 500

{String} snapTolId

The snapping tool id on the editing window

Default Value:: editconfig_snapTolerance

{Number} snapWidth

The Snapping width configured for the Editing Task

Default Value:: 8

{String} xyDivId

The container div id the xy editing window

Default Value:: esri_editXYDiv

Method Detail

attributesUpdateHandler(xml)

This method renders the attribute table and updates the contents of this attribute table during Editing task updates.

Parameters:
{XMLNode} xml

clearEditSketch(collid)

This method clears partial dijitized geometry based on the collection id. This parameter maps to collectionId attribute in JSF Button Tag a a:button id="addPolyline" mapId="map1" collectionId="E1" clientAction="adf.EditingPolyline"

Parameters:
{String} collid: Collection Id of the Editing Tool. This collection id identifies the adf.editingState the Editing Tool belongs to

closeEditorWindowHandler(win)

This event handler is called when the adf.EditTaskSettings#editorWin event adf.Window#event:onCancel occurs. This handler does post processing based on the editing Workflow that was happening when this event occured. If the user was middle of digitizing a geometry and had set EditTask for confirmations based on this adf.EditTaskSettings#silentClearSketch boolean value. This method will then prompt user for confirmation. Also if this is a non-versioned non-pooled Editing workflow the user is prompted for saving or discarding the edits. Based on these confirmations this method sends a AJAX request to close the Editing Session. This request is sent only when the Confirmations are set to close the session. Otherwise, The window is re-opened again for continuing the current work flow.

Parameters:
{adf.Window} win: Reference to the window being closed, No longer required to pass this information. @deprecated

closeEditorWindowRequest(action)

This sends the AJAX request when the window is closed. {adf.EditTask#editorShowWindowHandler} invokes this method

Parameters:
{String} action

configBeanHandler(xml)

This method sets the Configuration of the Editing Task based on the Config Bean, if it was defined when the task was created. This method is invoked by the {@link adf.EditTaskSettings#editbeanHandler) when there is "configBean" XML Node in its XML response. The snap rule settings for this task is also configured on the client by this method

Parameters:
{XMLNode} xml: This XML Node has the configuration information based on the Config Bean's settings for this Editing Task

createEditWindow(formId, editDivId)

This method creates a new Editing Window

Parameters:
{String} formId: The formId used by version window requests
{String} editDivId: The Container Div Id of the Editing Window

createSettingsWindow(formId, settingsDivId)

This method creates a new Settings Window

Parameters:
{String} formId: The formId used by settings window requests
{String} settingsDivId: The Container Div Id on to which the Setting Window is added

createVersionWindow(formId, editVersionDivId)

This method creates a new Version Window

Parameters:
{String} formId: The formId used by version window requests
{String} editVersionDivId: The Container Div Id on to which the Version Window is added

createXYWindow(formId, settingsDivId)

This method creates a new XY Window

Parameters:
{String} formId: The formId used by xy window requests
{String} settingsDivId: The Container Div Id on to which the XY Window is added

deactivateEditSketch(collid)

This method deactivates the Editing State adf.editingState's current ToolItem and the disbales the clearEditSkect Tool This parameter maps to collectionId attribute in JSF Button Tag a a:button id="addPolyline" mapId="map1" collectionId="E1" clientAction="adf.EditingPolyline"

Parameters:
{String} collid: Collection Id of the Editing Tool. This collection id identifies the adf.editingState the Editing Tool belongs to

editBeanHandler(xml)

This Ajax response handler does most of the business logic needed for Editor Task Window UI which depend on the synchronized state on the server and the client during the Editing Workflows For example these UI updates are handled by this method This Method is invoked on every postback to the server. See adf.EditTaskSettings#initEditor which registers this postbacktag handler. This method also invoked directly on every editor response , see adf.EditTaskSettings#updateEditorResponse

1. When you change layers in the Editing Task Window, Different set of tools are displayed
2. When you created a new feature either a point, polyline , polygon type, its corresponding
  edit feature Ids are enabled : delete, move, splitPolygon, mergePolyline and more

Parameters:
{XMLNode} xml

editorEnterXYWindowHandler(xml, eventsource)

Process postback xml response XY Window request

Parameters:
{XMLNode} xml: The Xml response return by the server when the XY Window based procsssing requets are sent to the server
{String} eventsource

editorExitWindowHandler(xml, action)

This AJAX handler called when window is exited It does the post-processing from the server side when the close window event occurs.

Parameters:
{XMLNode} xml
{String} action

editorShowWindowHandler(xml, eventsource, action)

This the AJAX response handler for showing window details

Parameters:
{XMLNode} xml: The Xml response return by the server when the showwindow request is sent by adf.EditTaskSettings#initEditorRequest
{String} eventsource
{String} action

enableClearSketch(enable, collid)

This method enables/diables the clearsketch tool of particulator toolitem collection The clearskecth is enabled when there is partial digitized geometry and diabled when there is not

Parameters:
{Boolean} enable: boolean parameter
{String} collid: Collection id of the ToolItem

enterXYRequest(eventSource, xID, yID)

This sends AJAX request method is to enter the XY values

Parameters:
{String} eventSource: The source of this event
{String} xID: The div Id of X value's input element
{String} yID: The div Id of Y vaue's input element

getCollectionId(eId)

This method returns the collectionID for a DOM Element This collection id identifies the adf.editingState the Editing Tool belongs to

Parameters:
eId

initEditor()

Initializes the Editing Task It creates the version, settings, edit and xy windows for the editing task. A postback tag handler "EditBean" is regsitered by this method.

initEditorRequest(action)

This method sends AJAX request during Editing Task window initialization to get the details and also when the Edit Task window is displayed

 sends a "showWindow" action which starts the Editing Session

Parameters:
{String} action: This indicates the server the type of action initaited by the client and maps to corresponding action on the server For Example

newXYWindowRequest(clientAction, serverAction)

This sends the new XY window request to initialize the setting for XY Window

Parameters:
{String} clientAction: The client side Editing Action of type adf.EditingDrawAction performed by this window
{String} serverAction: The corresponding Server-side action

refreshEditor()

This method refreshes the Editing Task

refreshEditorRequest(action, eventSource)

This method sends AJAX request to Start Editing, it is invoked by clicking Start Editing Button in Version Window

Parameters:
{String} action: The Name of the action sent to the server's editbean
{String} eventSource: The source of this event, maps to the DOM Element's Id

refreshVersionsRequest(configName)

This method sends an AJAX request to the server when the editing configuration is changed in the version window

Parameters:
{String} configName: This is the configuration name set in Editing Task Maps to mapContext.attributes.mapEditor.configurationName

resetLayer()

This event listener is invoked when the Editing Task Select Layer onChange event is fired. This determines whether the layer change can be done or not, by prompting for confirmation when there is partial digitized geomtery created before the layer onChange event occured if the change is confirmed, an AJAX request is sent to the server to refresh the editor by calling adf.EditTaskSettings#refreshEditorRequest method

sessionButtonsHandle(xml)

This handler updates the state of the Session Buutons Ui on the Editor Task Window. These buttons include save, discard, undo , redo which get enabled/disabled during nonpooled editing and versioned editing workflows

Parameters:
{XMLNode} xml

showAttributesIndex(selected)

This method provides paged view of attributes Table based on preOID,firstOID,nextOID,lastOID

Parameters:
selected

showEditorWindow()

This method Shows the Editing Task, it sends an AJAX request to the server informing the EditBean about this action through adf.EditTaskSettings#initEditorRequest method. The action sent to the server is "showWindow" This actually starts the Editing Session on the server

showEnterXYWindow()

This shows the XY window for entering X, Y map coordinate values through text box rather than drawing them on the map It sends an AJAX request to the server to initialize the settings required for this window by invoking adf.EdiTaskSettings#showEnterXYWindow

showLayerList(xml)

This method Creates the selection input box for showing different layers and registers the events listeners for this DOM.

Parameters:
xml

showSelectedAttributes(xml, attsDiv)

show the attributes in the currented selected view , The attributes table provides a pageable view to the user, The selected attribute in the current selected page is shown through this method

Parameters:
xml
attsDiv

showSnapRules(rulesDiv, xml)

This Method sets the snapping rules for this editing task. It is invoked by adf.EditTaskSettings#configBeanHandler

Parameters:
{DOMNode} rulesDiv: This is the containing div element for the Snapping Rules Table
{XMLNode} xml: This response XMl provides the detail on the Snapping Rules set for this task

storeSelectedLayer()

This method stores the selected layer into adf.EditTaskSettings#selectedLayer

updateAttributeRequest(id, value)

This method sends an AJAX request when the value of the attribute is updated/changed. The server validates the changed/updated vlaue ,it rejects the update when validation fails

Parameters:
{String} id: The Attribute id
{Number|String} value: The updated value for this attribute To preserve the datatype pf the value , this parameter is encoded and sent to the server

updateEditorResponse(xmlHttp, response, requestParams)

This is a Centralized AJAX Response handler for all the Editor Task AJAX request sent by adf.EditTaskSettings#initEditorRequest, adf.EditTaskSettings#refreshEditorRequest , adf.EditTaskSettings#updateAttributeRequest , adf.EditTaskSettings#closeEditorWindowRequest This method filters the response then calls the specific methods which handles the responses pertaining to its task. Following Methods are called based on the response tags, eventsource information through this method when the AJAX Response is received

Condition	Function Invoked
When requestParams.ajaxServerAction == "updateAttributes"	adf.EditTaskSettings#attributesUpdateHandler
eventsource == "versionWindow"	adf.EditTaskSettings#versionWindowHandler
when XMLNode "EditBean" is present	adf.EditTaskSettings#editBeanHandler
when XMLNode "EditorEnterXYWin" is present	adf.EditTaskSettings#editorEnterXYWindowHandler
when XMLNode "EditorExitConfirmWindow" is present	adf.EditTaskSettings#editorExitWindowHandler
when XMLNode "EditorWindow" is present	adf.EditTaskSettings#editorShowWindowHandler

Parameters:
{@deprecated} xmlHttp
{XMLNode} response
{Object} requestParams

updateSettingsRequest(name, value, layer)

This method sends an AJAX request when the value of the settings attributes is changed like snapping rules, snap Tolerance.

Parameters:
{String} name: The name of the settings parameter
{String} value: The updated value for this attribute
{String} layer: The name of the layer that this update affects

updateSnapRules(xmlHttp, response)

This method handles the AJAX response when the snaprules are updated

Parameters:
{XMLHTTPRequest @deprecated} xmlHttp
{XMLNode} response

updateSnapStatus(xml)

This Method is used for dyanmically updating the snapping rules when the Editing Task is being used. Every rule change is sent to the server to update its state and the response is confirmed back on the server We recommend users to minimze the excessive updates on the snappings rules which may slow down the performance.

Parameters:
{XMLNode} xml

versionWindowHandler(xml)

This handler sets up the settings sent by the server for the version window

Parameters:
{XMLNode} xml

Classes

Class adf.EditTaskSettings

Condition

Function Invoked