Namespace gxe.cfg

Static utilities for processing JSON based configuration objects associated with an editor definition.
Defined in: gxe.js.

Namespace Summary
Constructor Attributes	Constructor Name and Description
	gxe.cfg

Field Summary
Field Attributes	Field Name and Description
	pfxGxe the GXE namespace prefix (="g")
	pfxHtml the GXE HTML namespace prefix (="h")
	uriGxe the GXE namespace URI (="http://www.esri.com/geoportal/gxe")
	uriGxeHtml the GXE HTML namespace URI (="http://www.esri.com/geoportal/gxe/html")

Method Summary
Method Attributes	Method Name and Description
<static>	gxe.cfg.findChild(cfgObject, namespace, name) Finds an immediate child of a configuration object.
<static>	gxe.cfg.findGxeChild(cfgObject, name) Finds an immediate child of a configuration object within the GXE namespace.
<static>	gxe.cfg.forEachChild(cfgObject, namespace, name, callback) Executes a function for each immediate and matching child of a configuration object.
<static>	gxe.cfg.forEachHtmlAttribute(cfgObject, callback) Executes a function for each HTML attribute associated with a configuration object.
<static>	gxe.cfg.getAttributeValue(cfgObject, namespace, name) Gets an attribute value.
<static>	gxe.cfg.getGxeAttributeValue(cfgObject, name) Gets an attribute value within the GXE namespace.
<static>	gxe.cfg.getGxeHtmlAttributeValue(cfgObject, name) Gets an attribute value within the GXE HTML namespace.
<static>	gxe.cfg.getLabelText(cfgObject) Gets the g:label attribute value associated with a configuration object.
<static>	gxe.cfg.getMaxOccurs(cfgObject) Gets the g:maxOccurs attribute value associated with a configuration object.
<static>	gxe.cfg.getMinOccurs(cfgObject) Gets the g:minOccurs attribute value associated with a configuration object.
<static>	gxe.cfg.getTargetName(cfgObject) Gets the name for the XML target associated with a configuration object.
<static>	gxe.cfg.getTargetNS(cfgObject) Gets the namespace for the XML target associated with a configuration object.
<static>	gxe.cfg.initialize(cfgDefinition) Initializes the configured definition for an editor.

Namespace Detail

gxe.cfg

Field Detail

{String} pfxGxe

the GXE namespace prefix
(="g")

{String} pfxHtml

the GXE HTML namespace prefix
(="h")

{String} uriGxe

the GXE namespace URI
(="http://www.esri.com/geoportal/gxe")

{String} uriGxeHtml

the GXE HTML namespace URI
(="http://www.esri.com/geoportal/gxe/html")

Method Detail

<static> {cfgObject} gxe.cfg.findChild(cfgObject, namespace, name)

Finds an immediate child of a configuration object.

Example:
gxe.cfg.findChild(cfgObject,"http://www.esri.com/geoportal/gxe","options");

Parameters:
{cfgObject} cfgObject: the configuration object to process
{String} namespace: the configuration namespace of the child to find
{String} name: the configuration name of the child to find

Returns:: {cfgObject} the located child (null if not found)

<static> {cfgObject} gxe.cfg.findGxeChild(cfgObject, name)

Finds an immediate child of a configuration object within the GXE namespace.
(i.e. namespace "http://www.esri.com/geoportal/gxe")

Example:
gxe.cfg.findGxeChild(cfgObject,"options");

Parameters:
{cfgObject} cfgObject: the configuration object to process
{String} name: the configuration name of the child to find

Returns:: {cfgObject} the located child (null if not found)

<static> gxe.cfg.forEachChild(cfgObject, namespace, name, callback)

Executes a function for each immediate and matching child of a configuration object.

The callback function will have the following signature: function(cfgChild) {}
The callback function can return the String "break" to terminate the loop.

Parameters:
{cfgObject} cfgObject: the configuration object to process
{String} namespace: the configuration namesapce to match (* to match any)
{String} name: the configuration name to match (* to match any)
{function} callback: the callback function

<static> gxe.cfg.forEachHtmlAttribute(cfgObject, callback)

Executes a function for each HTML attribute associated with a configuration object.
(i.e. each attribute within namespace "http://www.esri.com/geoportal/gxe/html")

The callback function will have the following signature: function(cfgAttribute) {}
The callback function can return the String "break" to terminate the loop.

Parameters:
{cfgObject} cfgObject: the configuration object to process
{function} callback: the callback function

<static> {Object} gxe.cfg.getAttributeValue(cfgObject, namespace, name)

Gets an attribute value.

Example:
gxe.cfg.getAttributeValue(cfgObject,"http://www.esri.com/geoportal/gxe","minOccurs");

Parameters:
{cfgObject} cfgObject: the configuration object to process
{String} namespace: the configuration namespace of the attribute to find
{String} name: the configuration name of the attribute to find

Returns:: {Object} the attribute value (null if not found)

<static> {Object} gxe.cfg.getGxeAttributeValue(cfgObject, name)

Gets an attribute value within the GXE namespace.
(i.e. namespace "http://www.esri.com/geoportal/gxe")

Example:
gxe.cfg.getGxeAttributeValue(cfgObject,"minOccurs");

Parameters:
{cfgObject} cfgObject: the configuration object to process
{String} name: the configuration name of the attribute to find

Returns:: {Object} the attribute value (null if not found)

<static> {Object} gxe.cfg.getGxeHtmlAttributeValue(cfgObject, name)

Gets an attribute value within the GXE HTML namespace.
(i.e. namespace "http://www.esri.com/geoportal/gxe/html")

Example:
gxe.cfg.getGxeHtmlAttributeValue(cfgObject,"maxlength");

Parameters:
{cfgObject} cfgObject: the configuration object to process
{String} name: the configuration name of the attribute to find

Returns:: {Object} the attribute value (null if not found)

<static> {String} gxe.cfg.getLabelText(cfgObject)

Gets the g:label attribute value associated with a configuration object.
If null, the associated XML target name will be returned.

Parameters:
{cfgObject} cfgObject: the configuration object to process

Returns:: {String} the attribute value (null if not found)

<static> {String} gxe.cfg.getMaxOccurs(cfgObject)

Gets the g:maxOccurs attribute value associated with a configuration object.

Parameters:
{cfgObject} cfgObject: the configuration object to process

Returns:: {String} the attribute value (null if not found)

<static> {String} gxe.cfg.getMinOccurs(cfgObject)

Gets the g:minOccurs attribute value associated with a configuration object.

Parameters:
{cfgObject} cfgObject: the configuration object to process

Returns:: {String} the attribute value (null if not found)

<static> {String} gxe.cfg.getTargetName(cfgObject)

Gets the name for the XML target associated with a configuration object.

Parameters:
{cfgObject} cfgObject: the configuration object to process

Returns:: {String} the target name

<static> {String} gxe.cfg.getTargetNS(cfgObject)

Gets the namespace for the XML target associated with a configuration object.
If the supplied configuration object was not directly configured with a g:targetNS attribute, then the value will be inherited from the first applicable ancestor.

Parameters:
{cfgObject} cfgObject: the configuration object to process

Returns:: {String} the target namespace

<static> gxe.cfg.initialize(cfgDefinition)

Initializes the configured definition for an editor.

Parameters:
{cfgObject} cfgDefinition: the configured editor definition (JSON)

Classes

Namespace gxe.cfg