Namespace: a11y

OpenAjax.a11y

Source:
  • openajax_a11y_constants.js, line 54

Constructors

CacheItemResult
EvaluationResult
FilteredCacheItemResults
FilteredNodeResult
FilteredRuleResult
FilteredRuleResultsGroup
FilteredRuleResultsGroups
NodeResult
ResultSummary
Rule
RuleMapping
RuleResult
Rules
Ruleset
Rulesets

Namespaces

cache
formatters
info
nls
util

Members

<static> all_rules :Rules

Object containing data and methods related to rules

Source:
  • openajax_a11y.js, line 90

<static> all_wcag20_nls :WCAG20NLS

Object containing data and methods related to localized versions of WCAG 2.0 requirements

Source:
  • openajax_a11y.js, line 114

<static, constant> CACHE_NAMES :Array

Property names of specialized caches

Source:
  • openajax_a11y_constants.js, line 435

<static> cache_nls :CacheNLS

Object containing data and methods for generating human readable text for cache item properties and values

Source:
  • openajax_a11y.js, line 102

<static, constant> CONTROL_TYPE :Number

Indentify the cache control element type

Source:
  • openajax_a11y_constants.js, line 788
Example
OpenAjax.a11y.CONTROL_TYPE.UNKNOWN  
OpenAjax.a11y.CONTROL_TYPE.BUTTON_ELEMENT   
OpenAjax.a11y.CONTROL_TYPE.BUTTON_INPUT   
OpenAjax.a11y.CONTROL_TYPE.CHECKBOX   
OpenAjax.a11y.CONTROL_TYPE.FIELDSET 
OpenAjax.a11y.CONTROL_TYPE.FORM     
OpenAjax.a11y.CONTROL_TYPE.HIDDEN   
OpenAjax.a11y.CONTROL_TYPE.IMAGE    
OpenAjax.a11y.CONTROL_TYPE.LABEL    
OpenAjax.a11y.CONTROL_TYPE.OPTION   
OpenAjax.a11y.CONTROL_TYPE.OPTGROUP   
OpenAjax.a11y.CONTROL_TYPE.PASSWORD 
OpenAjax.a11y.CONTROL_TYPE.RADIO    
OpenAjax.a11y.CONTROL_TYPE.RESET    
OpenAjax.a11y.CONTROL_TYPE.SELECT   
OpenAjax.a11y.CONTROL_TYPE.SUBMIT   
OpenAjax.a11y.CONTROL_TYPE.TEXT     
OpenAjax.a11y.CONTROL_TYPE.TEXTAREA 
OpenAjax.a11y.CONTROL_TYPE.WIDGET 

<static, constant> DATA_TABLE_ASSUMPTION :Boolean

If true assume table markup is for a data table If false assume table markup is for layout, unless header cells or other information indciates its a data table

Default Value:
  • true
Source:
  • openajax_a11y_constants.js, line 130

<static, constant> DEFAULT_PREFS :Object

Default setting for consumers of the OpenAjax cache

Source:
  • openajax_a11y_constants.js, line 182

<static, constant> ELEMENT_FORMATING :String

Defines the formating of element names in NLS message strings

Default Value:
  • 'CAPS'
Source:
  • openajax_a11y_constants.js, line 144

<static, constant> ELEMENT_TYPE :Number

Numercial constant representing a element type option

Source:
  • openajax_a11y_constants.js, line 386
Example
OpenAjax.a11y.ELEMENT_TYPE.UNKNOWN  
OpenAjax.a11y.ELEMENT_TYPE.ALL   
OpenAjax.a11y.ELEMENT_TYPE.AUDIO   
OpenAjax.a11y.ELEMENT_TYPE.AUDIO_VIDEO      
OpenAjax.a11y.ELEMENT_TYPE.FORM_CONTROLS      
OpenAjax.a11y.ELEMENT_TYPE.HEADINGS      
OpenAjax.a11y.ELEMENT_TYPE.HEADINGS_LANDMARKS      
OpenAjax.a11y.ELEMENT_TYPE.IMAGES      
OpenAjax.a11y.ELEMENT_TYPE.LANDMARKS      
OpenAjax.a11y.ELEMENT_TYPE.LANGUAGE      
OpenAjax.a11y.ELEMENT_TYPE.LINKS      
OpenAjax.a11y.ELEMENT_TYPE.LISTS      
OpenAjax.a11y.ELEMENT_TYPE.TABLES      
OpenAjax.a11y.ELEMENT_TYPE.TEXT      
OpenAjax.a11y.ELEMENT_TYPE.TIMING      
OpenAjax.a11y.ELEMENT_TYPE.VIDEO      
OpenAjax.a11y.ELEMENT_TYPE.WIDGETS      

<static, constant> EVALUATION_LEVELS :Number

Constants related to the level of rules that wil be evaluated These are a bit mask for WCAG20_LEVEL constants

Source:
  • openajax_a11y_constants.js, line 497
Example
OpenAjax.a11y.EVALUATION_LEVELS.A
OpenAjax.a11y.EVALUATION_LEVELS.A_AA
OpenAjax.a11y.EVALUATION_LEVELS.A_AA_AAA

<static, constant> EVENT_HANDLER_PROCESSOR :String

Defines an event handler enumeration method Since there is no standard way to enumerate event handlers need to use proprietary methods to get event information. Current support: 'firefox' : uses Firefox (Mozilla) component technology to get event information 'fae-util' : uses HTMLUnit features of fae-util to find event information 'none' : disables gathering of event information and therefore event related rules are not analyzed

Default Value:
  • 'none'
Source:
  • openajax_a11y_constants.js, line 87

<static, constant> FILTERED_RULE_RESULT_RETURN_VALUE :Number

Used for rule aggregation

Source:
  • openajax_a11y_constants.js, line 910
Example
OpenAjax.a11y.FILTERED_RULE_RESULT_RETURN_VALUE.NO_MATCH
OpenAjax.a11y.FILTERED_RULE_RESULT_RETURN_VALUE.ADDED
OpenAjax.a11y.FILTERED_RULE_RESULT_RETURN_VALUE.NOT_ADDED

<static, constant> HEADER_SOURCE :Number

What markup was used as the source for table cell headers

Source:
  • openajax_a11y_constants.js, line 771
Example
OpenAjax.a11y.HEADER_SOURCE.NONE
OpenAjax.a11y.HEADER_SOURCE.HEADERS_ATTRIBUTE
OpenAjax.a11y.HEADER_SOURCE.ROW_OR_COLUMN_HEADERS

<static, constant> ID :Number

ID of an item

Source:
  • openajax_a11y_constants.js, line 671
Example
OpenAjax.a11y.ID.NOT_DEFINED
OpenAjax.a11y.ID.UNIQUE
OpenAjax.a11y.ID.NOT_UNIQUE

Constants for LINK cache elements

Source:
  • openajax_a11y_constants.js, line 878
Example
OpenAjax.a11y.LINK_TYPE.EMPTY
OpenAjax.a11y.LINK_TYPE.OTHER
OpenAjax.a11y.LINK_TYPE.INTERNAL
OpenAjax.a11y.LINK_TYPE.HTTP
OpenAjax.a11y.LINK_TYPE.HTTPS
OpenAjax.a11y.LINK_TYPE.FTP
OpenAjax.a11y.LINK_TYPE.FTS
OpenAjax.a11y.LINK_TYPE.FILE
OpenAjax.a11y.LINK_TYPE.JAVASCRIPT
OpenAjax.a11y.LINK_TYPE.MAILTO
OpenAjax.a11y.LINK_TYPE.TARGET

<static, constant> LIST :Number

Constants related to the lists cache

Source:
  • openajax_a11y_constants.js, line 688
Example
OpenAjax.a11y.LIST.CONTAINER
OpenAjax.a11y.LIST.ITEM
OpenAjax.a11y.LIST.LANDMARK

<static> locale :String

Current locale messages should use for generating text

Default Value:
  • en-us
Source:
  • openajax_a11y.js, line 77

<static> logger

logger object supports sending messages to the console This default logger object does nothing other than enumerate the minimal interface that must be implemented for logging Use the setLogger function to replace the default object with an object that supports logging in your development environment The replacement object may have additional methods defined by the host for controlling logging, but the OpenAjax Evaluation library will only use these 4 methods.

Source:
  • openajax_a11y.js, line 36

<static, constant> MAIN :Number

Constants for MAIN cache elements

Source:
  • openajax_a11y_constants.js, line 838
Example
OpenAjax.a11y.MAIN.ROLE_MAIN
OpenAjax.a11y.MAIN.H1_ELEMENT
OpenAjax.a11y.MAIN.TITLE_ELEMENT   

<static, constant> MEDIA :Number

Constants related to the probability of being media object with audio and video

Source:
  • openajax_a11y_constants.js, line 705
Example
OpenAjax.a11y.MEDIA.UNDEFINED
OpenAjax.a11y.MEDIA.NO
OpenAjax.a11y.MEDIA.MAYBE
OpenAjax.a11y.MEDIA.YES 

<static, constant> PROGRESS :Number

Progress log constants

Source:
  • openajax_a11y_constants.js, line 455
Example
OpenAjax.a11y.PROGRESS.UNDEFINED  
OpenAjax.a11y.PROGRESS.START      
OpenAjax.a11y.PROGRESS.CACHE_START
OpenAjax.a11y.PROGRESS.CACHE_END  
OpenAjax.a11y.PROGRESS.REQUIREMENT    
OpenAjax.a11y.PROGRESS.RULE          
OpenAjax.a11y.PROGRESS.COMPLETE   

<static, constant> REFERENCES :Number

Types of reference for supplemential materials to help people understand an accessibility requirement and how to improve the accessibility

Source:
  • openajax_a11y_constants.js, line 623
Example
OpenAjax.a11y.REFERENCES.UNKNOWN          
OpenAjax.a11y.REFERENCES.SPECIFICATION     
OpenAjax.a11y.REFERENCES.WCAG_TECHNIQUE        
OpenAjax.a11y.REFERENCES.TECHNIQUE        
OpenAjax.a11y.REFERENCES.EXAMPLE 
OpenAjax.a11y.REFERENCES.MANUAL_CHECK
OpenAjax.a11y.REFERENCES.AUTHORING_TOOL     
OpenAjax.a11y.REFERENCES.OTHER         

<static, constant> RESULT_FILTER :Number

Constants related to filtering both node results and rule results

Source:
  • openajax_a11y_constants.js, line 154
Example
OpenAjax.a11y.RESULT_FILTER.ALL
OpenAjax.a11y.RESULT_FILTER.PASS
OpenAjax.a11y.RESULT_FILTER.VIOLATION
OpenAjax.a11y.RESULT_FILTER.WARNING
OpenAjax.a11y.RESULT_FILTER.PAGE_MANUAL_CHECK
OpenAjax.a11y.RESULT_FILTER.ELEMENT_MANUAL_CHECK
OpenAjax.a11y.RESULT_FILTER.HIDDEN
OpenAjax.a11y.RESULT_FILTER.NA

<static, constant> RESULT_VALUE :Number

Result types of a rule results

Source:
  • openajax_a11y_constants.js, line 577
Example
OpenAjax.a11y.RESULT_VALUE.HIDDEN           
OpenAjax.a11y.RESULT_VALUE.MANUAL_CHECK
OpenAjax.a11y.RESULT_VALUE.NONE    
OpenAjax.a11y.RESULT_VALUE.NOT_EVALUATED    
OpenAjax.a11y.RESULT_VALUE.PAGE        
OpenAjax.a11y.RESULT_VALUE.PASS             
OpenAjax.a11y.RESULT_VALUE.VIOLATION        
OpenAjax.a11y.RESULT_VALUE.WARNING          

<static, constant> RULE_CATEGORIES :Number

Numercial constant representing a rule category and is bit maskable

Source:
  • openajax_a11y_constants.js, line 327
Example
OpenAjax.a11y.RULE_CATEGORIES.UNDEFINED  
OpenAjax.a11y.RULE_CATEGORIES.AUDIO_VIDEO      
OpenAjax.a11y.RULE_CATEGORIES.DATA_TABLES
OpenAjax.a11y.RULE_CATEGORIES.FORM_CONTROLS      
OpenAjax.a11y.RULE_CATEGORIES.IMAGES      
OpenAjax.a11y.RULE_CATEGORIES.KEYBOARD_SUPPORT
OpenAjax.a11y.RULE_CATEGORIES.LINKS      
OpenAjax.a11y.RULE_CATEGORIES.NAVIGATION_FINDABILITY
OpenAjax.a11y.RULE_CATEGORIES.STRUCTURE_CONTENT
OpenAjax.a11y.RULE_CATEGORIES.STYLES_READABILITY
OpenAjax.a11y.RULE_CATEGORIES.WIDGETS_SCRIPTS

<static, constant> RULE_GROUP :Number

Defines a grouping of rules

Source:
  • openajax_a11y_constants.js, line 517
Example
OpenAjax.a11y.RULE_GROUP.RULE_CATEGORIES               
OpenAjax.a11y.RULE_GROUP.WCAG20            
OpenAjax.a11y.RULE_GROUP.ALL_RULE_LIST           

<static, constant> RULE_SCOPE :Number

Defines a required or recommended rule

Source:
  • openajax_a11y_constants.js, line 535
Example
OpenAjax.a11y.RULE_SCOPE.UNKNOWN               
OpenAjax.a11y.RULE_SCOPE.NODE (deprecated)               
OpenAjax.a11y.RULE_SCOPE.ELEMENT               
OpenAjax.a11y.RULE_SCOPE.PAGE               

<static, constant> RULE_SUMMARY :Number

Numercial constant representing a rule summary option

Source:
  • openajax_a11y_constants.js, line 363
Example
OpenAjax.a11y.RULE_SUMMARY.UNDEFINED  
OpenAjax.a11y.RULE_SUMMARY.CATEGORIES  
OpenAjax.a11y.RULE_SUMMARY.WCAG20  
OpenAjax.a11y.RULE_SUMMARY.GUIDELINE  
OpenAjax.a11y.RULE_SUMMARY.RULESET_TYPE

<static, constant> SOURCE :Number

What markup was used as the source for calculating the accessible name

Source:
  • openajax_a11y_constants.js, line 741
Example
OpenAjax.a11y.SOURCE.NONE
OpenAjax.a11y.SOURCE.LABEL_REFERENCE
OpenAjax.a11y.SOURCE.LABEL_ENCAPSULATION
OpenAjax.a11y.SOURCE.TITLE_ATTRIBUTE
OpenAjax.a11y.SOURCE.VALUE_ATTRIBUTE
OpenAjax.a11y.SOURCE.ALT_ATTRIBUTE
OpenAjax.a11y.SOURCE.BUTTON_TYPE
OpenAjax.a11y.SOURCE.TEXT_CONTENT
OpenAjax.a11y.SOURCE.ARIA_LABELLEDBY
OpenAjax.a11y.SOURCE.ARIA_LABEL        

<static, constant> STATUS :Number

Status of rule acceptance for inclusion in the public ruleset

Source:
  • openajax_a11y_constants.js, line 604
Example
OpenAjax.a11y.STATUS.UNDEFINED
OpenAjax.a11y.STATUS.PROPOSED 
OpenAjax.a11y.STATUS.ACCEPTED
OpenAjax.a11y.STATUS.DEPRICATED

<static, constant> SUPPORTS_URL_TESTING :Boolean

If true the analysis engine supports URL testing

Default Value:
  • false
Source:
  • openajax_a11y_constants.js, line 119

<static, constant> TABLE :Number

Constants for TABLE cache elements

Source:
  • openajax_a11y_constants.js, line 854
Example
OpenAjax.a11y.TABLE.TABLE_ELEMENT   
OpenAjax.a11y.TABLE.CAPTION_ELEMENT 
OpenAjax.a11y.TABLE.THEAD_ELEMENT   
OpenAjax.a11y.TABLE.TBODY_ELEMENT   
OpenAjax.a11y.TABLE.TR_ELEMENT      
OpenAjax.a11y.TABLE.TH_ELEMENT      
OpenAjax.a11y.TABLE.TD_ELEMENT      

<static, constant> TEST_RESULT :Number

Types of node results from an evaluation

Source:
  • openajax_a11y_constants.js, line 554
Example
OpenAjax.a11y.TEST_RESULT.FAIL
OpenAjax.a11y.TEST_RESULT.HIDDEN
OpenAjax.a11y.TEST_RESULT.MANUAL_CHECK
OpenAjax.a11y.TEST_RESULT.NONE
OpenAjax.a11y.TEST_RESULT.PAGE
OpenAjax.a11y.TEST_RESULT.PASS

<static, constant> URL_RESULT :Number

Staus of rule acceptance for inclusion in the public ruleset

Source:
  • openajax_a11y_constants.js, line 723
Example
OpenAjax.a11y.URL_RESULT.INVALID
OpenAjax.a11y.URL_RESULT.VALID
OpenAjax.a11y.URL_RESULT.NOT_TESTED
OpenAjax.a11y.URL_RESULT.ERROR 

<static, constant> URL_TESTING_ENABLED :Boolean

Enable or disable testing of broken links the default should be false, due to performance issues of testing links

Default Value:
  • false
Source:
  • openajax_a11y_constants.js, line 106

<static, constant> VISIBILITY :Number

Visbility of an item in graphical renderings and to asssitive technologies

Source:
  • openajax_a11y_constants.js, line 655
Example
OpenAjax.a11y.VISIBILITY.UNKNOWN
OpenAjax.a11y.VISIBILITY.HIDDEN 
OpenAjax.a11y.VISIBILITY.VISIBLE

<static, constant> WCAG20_GUIDELINE :Number

Numercial constant representing a WCAG 2.0 Guidelines

Source:
  • openajax_a11y_constants.js, line 216
Example
OpenAjax.a11y.WCAG20_GUIDELINE.G_1_1  
OpenAjax.a11y.WCAG20_GUIDELINE.G_1_2  
OpenAjax.a11y.WCAG20_GUIDELINE.G_1_3  
OpenAjax.a11y.WCAG20_GUIDELINE.G_1_4  
OpenAjax.a11y.WCAG20_GUIDELINE.G_2_1  
OpenAjax.a11y.WCAG20_GUIDELINE.G_2_2  
OpenAjax.a11y.WCAG20_GUIDELINE.G_2_3  
OpenAjax.a11y.WCAG20_GUIDELINE.G_2_4  
OpenAjax.a11y.WCAG20_GUIDELINE.G_3_1  
OpenAjax.a11y.WCAG20_GUIDELINE.G_3_2  
OpenAjax.a11y.WCAG20_GUIDELINE.G_3_3  
OpenAjax.a11y.WCAG20_GUIDELINE.G_4_1  

<static, constant> WCAG20_LEVEL :Number

Constants related to the level of importance of a success criteria

Source:
  • openajax_a11y_constants.js, line 480
Example
OpenAjax.a11y.WCAG20_LEVEL.A
OpenAjax.a11y.WCAG20_LEVEL.AA
OpenAjax.a11y.WCAG20_LEVEL.AAA

<static, constant> WCAG20_PRINCIPLE :Number

Numercial constant representing a WCAG 2.0 Principles

Source:
  • openajax_a11y_constants.js, line 196
Example
OpenAjax.a11y.WCAG20_PRINCIPLE.P_1  
OpenAjax.a11y.WCAG20_PRINCIPLE.P_2  
OpenAjax.a11y.WCAG20_PRINCIPLE.P_3  
OpenAjax.a11y.WCAG20_PRINCIPLE.P_4  

<static, constant> WCAG20_SUCCESS_CRITERION :Number

Numercial constant representing a WCAG 2.0 Success Criteria

Source:
  • openajax_a11y_constants.js, line 252
Example
OpenAjax.a11y.WCAG20_SUCCESS_CRITERION.SC_1_1_1  
....
OpenAjax.a11y.WCAG20_SUCCESS_CRITERION.SC_4_1_2  

Methods

<static> all_rulsets() → {Object}

Object containing data and methods related to rulesets available for evaluation

Source:
  • openajax_a11y.js, line 116
Returns:
Type
Object

<static> getVersion() → {String}

Get the current version of the evaluation library, rules and rulesets

Source:
  • openajax_a11y_constants.js, line 61
Returns:
Returns the version number of the evaluation library
Type
String