Namespace idx.a11y

Provides functions to support A11y landmarks working in concert with idx.app.A11yPrologue.
Defined in: <idx\a11y.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	idx.a11y

Method Summary

Method Attributes	Method Name and Description
<static>	idx.a11y.getA11yStatementURL() Returns the accessibility statement URL set via idx.a11y.setA11yStatementURL.
<static>	idx.a11y.isBannerAreaRegistered() Checks if a node is currently registered as the "banner" landmark with idx.a11y.
<static>	idx.a11y.isMainAreaRegistered() Checks if a node is currently registered as the "main content" landmark with idx.a11y.
<static>	idx.a11y.isNavigationAreaRegistered() Checks if a node is currently registered as the "navigation" landmark with idx.a11y.
<static>	idx.a11y.registerBannerArea(nodeOrID) Registers the "banner" landmark and passes it on to the idx.app.A11yPrologue if it exists.
<static>	idx.a11y.registerMainArea(nodeOrID) Registers the "main contact" landmark and passes it on to the idx.app.A11yPrologue if it exists.
<static>	idx.a11y.registerNavigationArea(nodeOrID) Registers the "navigation" landmark and passes it on to the idx.app.A11yPrologue if it exists.
<static>	idx.a11y.registerShortcut(target, description, accessKey) Registers a keyboard shortcut and adds it to the prologue if one exists.
<static>	idx.a11y.setA11yStatementURL(url) Finds the idx.app.A11yPrologue for the page and if it exists, sets the accessibility statement URL for it.
<static>	idx.a11y.unregisterBannerArea(nodeOrID) Unregisters the "banner" landmark without registering a new node.
<static>	idx.a11y.unregisterMainArea(nodeOrID) Unregisters the "main contact" landmark without registering a new node.
<static>	idx.a11y.unregisterNavigationArea(nodeOrID) Unregisters the "navigation" landmark without registering a new node.
<static>	idx.a11y.unregisterShortcut(shortcutID) Unregisters a previously registered shortcut identified by the specified shortcut ID.

Constructor Detail

idx.a11y

See:: idx.app.A11yPrologue

Method Detail

<static> {String} idx.a11y.getA11yStatementURL()

Returns the accessibility statement URL set via idx.a11y.setA11yStatementURL. If the URL has been set directly in the A11yPrologue widget for the current page then this method will not reflect that.

Returns:: {String} The url for the applications accessibility statement.

<static> {Boolean} idx.a11y.isBannerAreaRegistered()

Checks if a node is currently registered as the "banner" landmark with idx.a11y.

Returns:: {Boolean} Returns true if a node is currently registered otherwise false.

See:: idx.a11y.registerNavigationArea

<static> {Boolean} idx.a11y.isMainAreaRegistered()

Checks if a node is currently registered as the "main content" landmark with idx.a11y.

Returns:: {Boolean} Returns true if a node is currently registered otherwise false.

See:: idx.a11y.registerMainArea

<static> {Boolean} idx.a11y.isNavigationAreaRegistered()

Checks if a node is currently registered as the "navigation" landmark with idx.a11y.

Returns:: {Boolean} Returns true if a node is currently registered otherwise false.

See:: idx.a11y.registerNavigationArea

<static> idx.a11y.registerBannerArea(nodeOrID)

Registers the "banner" landmark and passes it on to the idx.app.A11yPrologue if it exists. Any previously registered node is unregistered.

Parameters:
{Node|String} nodeOrID: The node or ID of the node to register.

<static> idx.a11y.registerMainArea(nodeOrID)

Registers the "main contact" landmark and passes it on to the idx.app.A11yPrologue if it exists. Any previously registered node is unregistered.

Parameters:
{Node|String} nodeOrID: The node or ID of the node to register.

<static> idx.a11y.registerNavigationArea(nodeOrID)

Registers the "navigation" landmark and passes it on to the idx.app.A11yPrologue if it exists. Any previously registered node is unregistered.

Parameters:
{Node|String} nodeOrID: The node or ID of the node to register.

<static> {String} idx.a11y.registerShortcut(target, description, accessKey)

Registers a keyboard shortcut and adds it to the prologue if one exists.

Parameters:
{Node|String} target: The target node or anchor string of the keyboard shortcut.
{String} description: The description of the shortcut to use in the prologue.
{String} accessKey: The access key for activating the shortcut.

Returns:: {String} The shortcut ID to use for unregistering the shortcut.

<static> idx.a11y.setA11yStatementURL(url)

Finds the idx.app.A11yPrologue for the page and if it exists, sets the accessibility statement URL for it.

Parameters:
{String} url: The url for the applications accessibility statement.

<static> idx.a11y.unregisterBannerArea(nodeOrID)

Unregisters the "banner" landmark without registering a new node.

Parameters:
{Node|String} nodeOrID: The node or ID of the node to unregister.

<static> idx.a11y.unregisterMainArea(nodeOrID)

Unregisters the "main contact" landmark without registering a new node.

Parameters:
{Node|String} nodeOrID: The node or ID of the node to unregister.

<static> idx.a11y.unregisterNavigationArea(nodeOrID)

Unregisters the "navigation" landmark without registering a new node.

Parameters:
{Node|String} nodeOrID: The node or ID of the node to unregister.

<static> idx.a11y.unregisterShortcut(shortcutID)

Unregisters a previously registered shortcut identified by the specified shortcut ID.

Parameters:
{Node|String} shortcutID: The ID of the shortcut to unregister.