Class adf.Controls

adf.Controls
Defined in: core.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	adf.Controls() This Class is used to access all maps, overviews, tasks, toolitemcolelctions, tocs and toolbars in ADF

Field Summary
Field Attributes	Field Name and Description
<static>	adf.Controls.contextPath
<static>	adf.Controls.errorPage User configured error page defined in web.xml for this web application, when there is an AJAX error
<static>	adf.Controls.mapIds
<static>	adf.Controls.maps
<static>	adf.Controls.overviewIds
<static>	adf.Controls.overviews
<static>	adf.Controls.redirectPage User configured redirect page defined in web.xml for this web application, when there is a Session Timeout at the Web Server.
<static>	adf.Controls.taskIds
<static>	adf.Controls.tasks
<static>	adf.Controls.tocIds
<static>	adf.Controls.tocs
<static>	adf.Controls.toolbarIds
<static>	adf.Controls.toolbars
<static>	adf.Controls.toolItemCollectionIds
<static>	adf.Controls.toolItemCollections

Method Summary
Method Attributes	Method Name and Description
<static>	adf.Controls.addPostBackTagHandler(tagName, handler) Registers a function to be called when an XML response is parsed and reaches the provided tag name.
<static>	adf.Controls.getToolItemCollection(collectionId, mapId, collectionType) This Method returns a toolitem collection {@link adf.
<static>	adf.Controls.processPostBack(xmlHttpResponse) The default AJAX response handler for ADF lifecycle requests.
<static>	adf.Controls.processPostBackXML(xml) Parses the ADF XML response for AJAX requests sent a server webcontrol.
<static>	adf.Controls.removePostBackTagHandler(tagName, handler) Removes a function handler added with adf.Controls.addPostBackTagHandler.

Class Detail

adf.Controls()

This Class is used to access all maps, overviews, tasks, toolitemcolelctions, tocs and toolbars in ADF

 var map = adf.Controls.maps["map1"];
 var map = adf.Controls.tasks["task1"];
 var editingState = adf.Controls.toolItemCollections["E1"];

Field Detail

<static> adf.Controls.contextPath

<static> {String} adf.Controls.errorPage

User configured error page defined in web.xml for this web application, when there is an AJAX error

<static> adf.Controls.mapIds

<static> adf.Controls.maps

<static> adf.Controls.overviewIds

<static> adf.Controls.overviews

<static> {String} adf.Controls.redirectPage

User configured redirect page defined in web.xml for this web application, when there is a Session Timeout at the Web Server.

<static> adf.Controls.taskIds

<static> adf.Controls.tasks

<static> adf.Controls.tocIds

<static> adf.Controls.tocs

<static> adf.Controls.toolbarIds

<static> adf.Controls.toolbars

<static> adf.Controls.toolItemCollectionIds

<static> adf.Controls.toolItemCollections

Method Detail

<static> adf.Controls.addPostBackTagHandler(tagName, handler)

Registers a function to be called when an XML response is parsed and reaches the provided tag name. The function is executed through the framework in adf.Controls.processPostBackXML.

Parameters:
tagName: {String}
handler: {Function}

<static> adf.Controls.getToolItemCollection(collectionId, mapId, collectionType)

This Method returns a toolitem collection adf.

Parameters:
collectionId: {String}
mapId: {String}
collectionType: {String}

<static> adf.Controls.processPostBack(xmlHttpResponse)

The default AJAX response handler for ADF lifecycle requests.

Parameters:
xmlHttpResponse: {XMLHttpResponse} the response object

<static> adf.Controls.processPostBackXML(xml)

Parses the ADF XML response for AJAX requests sent a server webcontrol. Handles notification for registered "updateListeners" created using adf.Control.addUpdateListener.

Parameters:
xml: {XMLDocument} the xml document to parse

<static> adf.Controls.removePostBackTagHandler(tagName, handler)

Removes a function handler added with adf.Controls.addPostBackTagHandler.

Parameters:
tagName: {String} the name of the tag that the hanldler is registered for
handler: {Function} the handler function

Classes

Class adf.Controls