com.deque.worldspace

Class Rule

java.lang.Object

com.deque.worldspace.Rule

Direct Known Subclasses:

RuleAcronymAnnouncement, RuleControlLabels, RuleDroidClickableSpanInfo, RuleDroidDuplicateClickableBounds, RuleDroidEditableContDesc, RuleDroidRedundantContDesc, RuleDroidSpeakableText, RuleDroidTouchTargetSize, RuleEditTextControls, RuleImageViewControls, RuleTabWidgetControls

public abstract class Rule
extends java.lang.Object

A collection of checks that together represent a package of things to test together.

For example, checking for a content description alone may not be enough. We may also want to check for the present of text, a labelFor attribute, hints, etc. All of these checks together would form a rule.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Rule.Filter It is useful to filter rules based on the properties of the accessibility node info.
static class	Rule.RuleSet
class	Rule.Violation A collection of information regarding a tested node and the checks run on that node for a given rule.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Rule(java.lang.String description, java.lang.String helpUrl)

Method Summary

Modifier and Type	Method and Description
protected Rule	addCheckAll(Check check) Add a check for which all must pass for the rule to pass.
protected void	addFilterAll(Rule.Filter filter) Add a filter that MUST pass for the rule to be run.
protected void	addFilterAny(Rule.Filter filter) Add a filter that if passed, the rule will be run, unless a filter from the all filters removes it from consideration.
protected Rule	addIgnoredContainer(java.lang.Class<? extends android.view.ViewParent> clazz) Some containers need to be ignored for certain rules.
java.lang.String	getDescription() Get a description of the rule.
java.lang.String	getHelpText() Get the helpt text for the rule.
java.lang.String	getHelpUrl() Get the reference url for the rul.
java.lang.String	getId() Get the id for the rule.
static java.util.List<java.lang.Class<? extends Rule>>	getRuleClasses()
static java.util.List<java.lang.Class<? extends Rule>>	getRuleClassesDeque() Get a list of classes for all of the Deque implemented rules in this build.
static java.util.List<java.lang.Class<? extends Rule>>	getRuleClassesGoogle() Get a list of rules for the Android implemented rule classes for this build.
protected boolean	isContainerIgnored(A11yNodeInfo nodeInfo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Rule

protected Rule(java.lang.String description,
               java.lang.String helpUrl)

Method Detail

getRuleClasses

public static java.util.List<java.lang.Class<? extends Rule>> getRuleClasses()

getRuleClassesDeque

public static java.util.List<java.lang.Class<? extends Rule>> getRuleClassesDeque()

Get a list of classes for all of the Deque implemented rules in this build.

Returns:

List of classes.

getRuleClassesGoogle

public static java.util.List<java.lang.Class<? extends Rule>> getRuleClassesGoogle()

Get a list of rules for the Android implemented rule classes for this build.

Returns:

List of classes.

getDescription

public java.lang.String getDescription()

Get a description of the rule.

Returns:

the description

getHelpText

public java.lang.String getHelpText()

Get the helpt text for the rule.

Returns:

The help text.

getHelpUrl

public java.lang.String getHelpUrl()

Get the reference url for the rul.

Returns:

The url.

getId

public java.lang.String getId()

Get the id for the rule.

Returns:

The id.

addFilterAll

protected void addFilterAll(Rule.Filter filter)

Add a filter that MUST pass for the rule to be run.

Parameters:

filter - The filter.

addFilterAny

protected void addFilterAny(Rule.Filter filter)

Add a filter that if passed, the rule will be run, unless a filter from the all filters removes it from consideration.

Parameters:

filter - The filter.

addIgnoredContainer

protected Rule addIgnoredContainer(java.lang.Class<? extends android.view.ViewParent> clazz)

Some containers need to be ignored for certain rules. Containers added to this list will stop traversal of the node heirarchy. Using this is much more performant than a filter all, when applicable.

Parameters:

clazz - The class of the container to ignore.

Returns:

this

addCheckAll

protected Rule addCheckAll(Check check)

Add a check for which all must pass for the rule to pass.

Parameters:

check - The check.

Returns:

this

isContainerIgnored

protected boolean isContainerIgnored(A11yNodeInfo nodeInfo)