Constructor: CacheItemResult

OpenAjax.a11y.CacheItemResult

new CacheItemResult(cache_item, filter, pos)

Represents one of the cache items in a cache items filter result object

Parameters:
Name Type Description
cache_item CacheItem cache item to be included in filtered results
filter Number Number representing the types of results to include in the array
pos Number Position in a list
Source:
  • scripts/filtered_cache_item_results.js, line 642

Methods

<static> addChildCacheItemResult(cache_item)

Adds a cache item result to the children list of a cache item result object

Parameters:
Name Type Description
cache_item CacheItem Object cache item to be included in filtered results
Source:
  • scripts/filtered_cache_item_results.js, line 759

<static> agetCacheItem() → {Object}

Get cache item object

Source:
  • scripts/filtered_cache_item_results.js, line 794
Returns:
Cache item object
Type
Object

<static> getHighestResultValueConstant() → {Number}

Gets highest result value for the node results for this cache item

Source:
  • scripts/filtered_cache_item_results.js, line 844
Returns:
Number representing the highest result value
Type
Number

<static> getNodeResults(Array)

Gets an array of node results for the cache item

Parameters:
Name Type Description
Array Array of node results
Source:
  • scripts/filtered_cache_item_results.js, line 871

<static> getOrdinalPosition(Number)

Gets ordinal position of the cache item in the DOM, 1 based

Parameters:
Name Type Description
Number Number representing the ordinal position
Source:
  • scripts/filtered_cache_item_results.js, line 887

<static> getResultSummary() → {ResultSummary}

Gets numerical summary information about the cache item results

Source:
  • scripts/filtered_cache_item_results.js, line 811
Returns:
Returns the ResultSummary object
Type
ResultSummary

<static> hasResults(True)

Tests if node has any rule results

Parameters:
Name Type Description
True Boolean if there are rule results, otherwise false
Source:
  • scripts/filtered_cache_item_results.js, line 828

<static> isTree() → {Boolean}

Tests if the cache items has a tree structure (otherwise simple list)

Source:
  • scripts/filtered_cache_item_results.js, line 779
Returns:
true if cache items are organized as a tree, otherwise false
Type
Boolean

<static> toJSON(prefix) → {String}

Returns a JSON representation of the cache item

Parameters:
Name Type Description
prefix String A prefix string typically spaces
Source:
  • scripts/filtered_cache_item_results.js, line 904
Returns:
String representing the cache item result object
Type
String