Constructor: PageElementHeadingsLandmarks

OpenAjax.a11y.cache.PageElementHeadingsLandmarks

new PageElementHeadingsLandmarks(dom_element, parent_landmark)

Creates a body element object used to hold information about a title element

Parameters:
Name Type Description
dom_element DOMelement The dom element object representing the heading element
parent_landmark MainElement This is always null since this is the root element
Properties:
Name Type Description
dom_element DOMElement Reference to the dom element representing the optgroup element
cache_id String String that uniquely identifies the cache element object in the cache
document_order Number Ordinal position of the title and main cache items in the document to other title and main cache items
parent_landmark MainElement Information about the parent main landmark (NOTE: can be null)
child_cache_elements Array List of child cache title element, main landmarks and h1 heading element objects as part of cache title and main elements tree
type Number Constant representing the body element
Source:
  • scripts/cache_headings_landmarks.js, line 2007

Methods

<static> addChildMainElement(main_element)

Adds a main landmark object to the tree of title and main elements

Parameters:
Name Type Description
main_element MainElement Main landmark element object to add
Source:
  • scripts/cache_headings_landmarks.js, line 2047

<static> getAttributes(unsorted) → {Array}

Returns an array of attributes for the element, sorted in alphabetical order

Parameters:
Name Type Description
unsorted Boolean If defined and true the results will NOT be sorted alphabetically
Source:
  • scripts/cache_headings_landmarks.js, line 2095
Returns:
Returns a array of attribute display object
Type
Array

<static> getCacheProperties(unsorted) → {Array}

Returns an array of cache properties sorted by property name

Parameters:
Name Type Description
unsorted Boolean If defined and true the results will NOT be sorted alphabetically
Source:
  • scripts/cache_headings_landmarks.js, line 2119
Returns:
Returns a array of cache property display object
Type
Array

<static> getCachePropertyValue(property) → {String|Number}

Returns the value of a property

Parameters:
Name Type Description
property String The property to retreive the value
Source:
  • scripts/cache_headings_landmarks.js, line 2142
Returns:
Returns the value of the property
Type
String | Number

<static> getEvents() → {Array}

Returns an array of events for the element, sorted in alphabetical order

Source:
  • scripts/cache_headings_landmarks.js, line 2165
Returns:
Returns a array of event item display objects
Type
Array

<static> getNodeResults() → {Array}

Returns an array of node results in severity order

Source:
  • scripts/cache_headings_landmarks.js, line 2065
Returns:
Returns a array of node results
Type
Array

<static> getStyle() → {Array}

Returns an array of style items

Source:
  • scripts/cache_headings_landmarks.js, line 2079
Returns:
Returns a array of style display objects
Type
Array

<static> toString() → {String}

Returns a text string representation of the title element

Source:
  • scripts/cache_headings_landmarks.js, line 2181
Returns:
Returns string represention the title element object
Type
String