Constructor: TreeViewOfFilteredRuleResultsGroups

OpenAjax.a11y.formatters.TreeViewOfFilteredRuleResultsGroups

new TreeViewOfFilteredRuleResultsGroups(filtered_rule_results_groups, level)

Constructs a list of rule groups results that can be used by tree views (i.e. XUL custom tree views)

Parameters:
Name Type Description
filtered_rule_results_groups FilteredRuleResultsGroups Filtered rule results groups object
level Number level of this list in the tree structure
Properties:
Name Type Description
filtered_rule_results_groups FilteredRuleResultsGroups Filtered rule results groups object reference
rule_result_items Array List of rule result itmes with properties optimized for tree view or list rendering
Source:
  • scripts/formatter_tree_view.js, line 28

Methods

<static> getOpenRuleResults() → {Array}

Returns an array of all the rule result items, including the items in the children property of items with open property set to true

Source:
  • scripts/formatter_tree_view.js, line 203
Returns:
Array of rule result items optimized for a tree view
Type
Array

<static> setOpenState(flag)

Sets open state on all container items in the list Used for expanding or collapsing all leafs in a tree

Parameters:
Name Type Description
flag Boolean If true all container elements will be set to open, otherwise containers element set to close
Source:
  • scripts/formatter_tree_view.js, line 168

<static> sortedListOfRules(sort_property, order) → {Array}

Sorts the list of rule result items based on item property values

Parameters:
Name Type Description
sort_property String Name of property to sort, property names include: 'violations_count', 'warnings_count', 'failures_count', 'manual_checks_count', 'passed_count'
order Number If 1 sort ascending, else sort descending
Source:
  • scripts/formatter_tree_view.js, line 244
Returns:
Array of objects optimized for display as a tree
Type
Array