Constructor: ContainerElement

OpenAjax.a11y.cache.ContainerElement

new ContainerElement(dom_element, list_info)

Cache object to be inserted into ListsCache; corresponds to either a OL, UL, DL element in the DOM

Parameters:
Name Type Description
dom_element DOMelement The dom element object representing the input element
list_info ListInfo Current list information about
Properties:
Name Type Description
dom_element DOMElement Reference to the dom element representing the container element
cache_id String String that uniquely identifies the cache element object in the cache
document_order Number Ordinal position of the container element in the document
parent_container ContainerElement Reference to the container element the container element is contained in
parent_landmark LandmarkElement Reference to the landmark element the container element is contained in
list_type Number Type of list cache element object
child_cache_elements Array Array of child cache list elements as part of list cache tree
Source:
  • scripts/cache_lists.js, line 621

Methods

<static> addChildElement(list_element) → {boolean}

Add a list element object to the tree of list cache items

Parameters:
Name Type Description
list_element ContainerElement | ListElement | LandmarkElement list cache element object to add to the list cache
Source:
  • scripts/cache_lists.js, line 689
Returns:
indicating success or failure
Type
boolean

<static> addListElement(list_element) → {boolean}

Add a list element object to the list of list items

Parameters:
Name Type Description
list_element ListElement list element object to add to the list of list elements
Source:
  • scripts/cache_lists.js, line 662
Returns:
indicating success or failure
Type
boolean

<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_lists.js, line 785
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_lists.js, line 805
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_lists.js, line 831
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_lists.js, line 852
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_lists.js, line 755
Returns:
Returns a array of node results
Type
Array

<static> getStyle() → {Array}

Returns an array of style items

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

Check whether a list container contains at least the minimum number of li elements with one and only one link.

Parameters:
Name Type Description
min_li Number The minimum number of list elements with one link that the list element must contain.
Source:
  • scripts/cache_lists.js, line 712
Returns:
Returns true if the list is considered a list of links, otherwise false
Type
boolean

<static> toString() → {String}

Returns a text string representation of the container element object

Source:
  • scripts/cache_lists.js, line 869
Returns:
Returns string represention the container element object
Type
String