-
public class Accessibility.Feature.Companion
-
-
Field Summary
-
Method Summary
Modifier and Type Method Description final List<Accessibility.Feature>fromJSONArray(JSONArray json)Creates a list of Feature from its RWPM JSON representation. final JSONArraytoJSONArray(Set<Accessibility.Feature> $self)final Accessibility.FeaturegetANNOTATIONS()The work includes annotations from the author, instructor and/or others. final Accessibility.FeaturegetARIA()Indicates the resource includes ARIA roles to organize and improve the structure and navigation. final Accessibility.FeaturegetBOOKMARKS()The work includes bookmarks to facilitate navigation to key points. final Accessibility.FeaturegetINDEX()The work includes an index to the content. final Accessibility.FeaturegetPRINT_PAGE_NUMBERS()The work includes equivalent print page numbers. final Accessibility.FeaturegetREADING_ORDER()The reading order of the content is clearly defined in the markup (e.g., figures, sidebars and other secondary content has been marked up to allow it to be skipped automatically and/or manually escaped from). final Accessibility.FeaturegetSTRUCTURAL_NAVIGATION()The use of headings in the work fully and accurately reflects the document hierarchy, allowing navigation by assistive technologies. final Accessibility.FeaturegetTABLE_OF_CONTENTS()The work includes a table of contents that provides links to the major sections of the content. final Accessibility.FeaturegetTAGGED_PDF()The contents of the PDF have been tagged to permit access by assistive technologies. final Accessibility.FeaturegetALTERNATIVE_TEXT()Alternative text is provided for visual content (e.g. final Accessibility.FeaturegetAUDIO_DESCRIPTION()Audio descriptions are available (e.g. final Accessibility.FeaturegetCAPTIONS()Indicates that synchronized captions are available for audio and video content. final Accessibility.FeaturegetDESCRIBED_MATH()Textual descriptions of math equations are included, whether in the alt attribute for image-based equations, final Accessibility.FeaturegetLONG_DESCRIPTION()Descriptions are provided for image-based visual content and/or complex structures such as tables, mathematics, diagrams, and charts. final Accessibility.FeaturegetRUBY_ANNOTATIONS()Indicates that rubyannotations HTML are provided in the content.final Accessibility.FeaturegetSIGN_LANGUAGE()Sign language interpretation is available for audio and video content. final Accessibility.FeaturegetTRANSCRIPT()Indicates that a transcript of the audio content is available. final Accessibility.FeaturegetDISPLAY_TRANSFORMABILITY()Display properties are controllable by the user. final Accessibility.FeaturegetSYNCHRONIZED_AUDIO_TEXT()Describes a resource that offers both audio and text, with information that allows them to be rendered simultaneously. final Accessibility.FeaturegetTIMING_CONTROL()For content with timed interaction, this value indicates that the user can control the timing to meet their needs (e.g. final Accessibility.FeaturegetUNLOCKED()No digital rights management or other content restriction protocols have been applied to the resource. final Accessibility.FeaturegetCHEM_ML()Identifies that chemical information is encoded using the ChemML markup language. final Accessibility.FeaturegetLATEX()Identifies that mathematical equations and formulas are encoded in the LaTeX typesetting system. final Accessibility.FeaturegetMATH_ML()Identifies that mathematical equations and formulas are encoded in MathML. final Accessibility.FeaturegetTTS_MARKUP()One or more of SSML, Pronunciation-Lexicon, and CSS3-Speech properties has been used to enhance text-to-speech playback quality. final Accessibility.FeaturegetHIGH_CONTRAST_AUDIO()Audio content with speech in the foreground meets the contrast thresholds set out in WCAG Success Criteria 1.4.7. final Accessibility.FeaturegetHIGH_CONTRAST_DISPLAY()Content meets the visual contrast threshold set out in WCAG Success Criteria 1.4.6. final Accessibility.FeaturegetLARGE_PRINT()The content has been formatted to meet large print guidelines. final Accessibility.FeaturegetBRAILLE()The content is in braille format, or alternatives are available in braille. final Accessibility.FeaturegetTACTILE_GRAPHIC()When used with creative works such as books, indicates that the resource includes tactile graphics. final Accessibility.FeaturegetTACTILE_OBJECT()When used with creative works such as books, indicates that the resource includes models to generate tactile 3D objects. final Accessibility.FeaturegetNONE()Indicates that the resource does not contain any accessibility features. -
-
Method Detail
-
fromJSONArray
final List<Accessibility.Feature> fromJSONArray(JSONArray json)
Creates a list of Feature from its RWPM JSON representation.
-
toJSONArray
final JSONArray toJSONArray(Set<Accessibility.Feature> $self)
-
getANNOTATIONS
final Accessibility.Feature getANNOTATIONS()
The work includes annotations from the author, instructor and/or others.
-
getARIA
final Accessibility.Feature getARIA()
Indicates the resource includes ARIA roles to organize and improve the structure and navigation.
The use of this value corresponds to the inclusion of Document Structure, Landmark, Live Region, and Window roles WAI-ARIA.
-
getBOOKMARKS
final Accessibility.Feature getBOOKMARKS()
The work includes bookmarks to facilitate navigation to key points.
-
getINDEX
final Accessibility.Feature getINDEX()
The work includes an index to the content.
-
getPRINT_PAGE_NUMBERS
final Accessibility.Feature getPRINT_PAGE_NUMBERS()
The work includes equivalent print page numbers. This setting is most commonly used with ebooks for which there is a print equivalent.
-
getREADING_ORDER
final Accessibility.Feature getREADING_ORDER()
The reading order of the content is clearly defined in the markup (e.g., figures, sidebars and other secondary content has been marked up to allow it to be skipped automatically and/or manually escaped from).
-
getSTRUCTURAL_NAVIGATION
final Accessibility.Feature getSTRUCTURAL_NAVIGATION()
The use of headings in the work fully and accurately reflects the document hierarchy, allowing navigation by assistive technologies.
-
getTABLE_OF_CONTENTS
final Accessibility.Feature getTABLE_OF_CONTENTS()
The work includes a table of contents that provides links to the major sections of the content.
-
getTAGGED_PDF
final Accessibility.Feature getTAGGED_PDF()
The contents of the PDF have been tagged to permit access by assistive technologies.
-
getALTERNATIVE_TEXT
final Accessibility.Feature getALTERNATIVE_TEXT()
Alternative text is provided for visual content (e.g., via the HTML
altattribute).
-
getAUDIO_DESCRIPTION
final Accessibility.Feature getAUDIO_DESCRIPTION()
Audio descriptions are available (e.g., via an HTML
trackelement with itskindattribute set to "descriptions").
-
getCAPTIONS
final Accessibility.Feature getCAPTIONS()
Indicates that synchronized captions are available for audio and video content.
-
getDESCRIBED_MATH
final Accessibility.Feature getDESCRIBED_MATH()
Textual descriptions of math equations are included, whether in the alt attribute for image-based equations,
-
getLONG_DESCRIPTION
final Accessibility.Feature getLONG_DESCRIPTION()
Descriptions are provided for image-based visual content and/or complex structures such as tables, mathematics, diagrams, and charts.
-
getRUBY_ANNOTATIONS
final Accessibility.Feature getRUBY_ANNOTATIONS()
Indicates that
rubyannotations HTML are provided in the content. Ruby annotations are used as pronunciation guides for the logographic characters for languages like Chinese or Japanese. It makes difficult Kanji or CJK ideographic characters more accessible.The absence of rubyAnnotations implies that no CJK ideographic characters have ruby.
-
getSIGN_LANGUAGE
final Accessibility.Feature getSIGN_LANGUAGE()
Sign language interpretation is available for audio and video content.
-
getTRANSCRIPT
final Accessibility.Feature getTRANSCRIPT()
Indicates that a transcript of the audio content is available.
-
getDISPLAY_TRANSFORMABILITY
final Accessibility.Feature getDISPLAY_TRANSFORMABILITY()
Display properties are controllable by the user. This property can be set, for example, if custom CSS style sheets can be applied to the content to control the appearance. It can also be used to indicate that styling in document formats like Word and PDF can be modified.
-
getSYNCHRONIZED_AUDIO_TEXT
final Accessibility.Feature getSYNCHRONIZED_AUDIO_TEXT()
Describes a resource that offers both audio and text, with information that allows them to be rendered simultaneously. The granularity of the synchronization is not specified. This term is not recommended when the only material that is synchronized is the document headings.
-
getTIMING_CONTROL
final Accessibility.Feature getTIMING_CONTROL()
For content with timed interaction, this value indicates that the user can control the timing to meet their needs (e.g., pause and reset)
-
getUNLOCKED
final Accessibility.Feature getUNLOCKED()
No digital rights management or other content restriction protocols have been applied to the resource.
-
getCHEM_ML
final Accessibility.Feature getCHEM_ML()
Identifies that chemical information is encoded using the ChemML markup language.
-
getLATEX
final Accessibility.Feature getLATEX()
Identifies that mathematical equations and formulas are encoded in the LaTeX typesetting system.
-
getMATH_ML
final Accessibility.Feature getMATH_ML()
Identifies that mathematical equations and formulas are encoded in MathML.
-
getTTS_MARKUP
final Accessibility.Feature getTTS_MARKUP()
One or more of SSML, Pronunciation-Lexicon, and CSS3-Speech properties has been used to enhance text-to-speech playback quality.
-
getHIGH_CONTRAST_AUDIO
final Accessibility.Feature getHIGH_CONTRAST_AUDIO()
Audio content with speech in the foreground meets the contrast thresholds set out in WCAG Success Criteria 1.4.7.
-
getHIGH_CONTRAST_DISPLAY
final Accessibility.Feature getHIGH_CONTRAST_DISPLAY()
Content meets the visual contrast threshold set out in WCAG Success Criteria 1.4.6.
-
getLARGE_PRINT
final Accessibility.Feature getLARGE_PRINT()
The content has been formatted to meet large print guidelines.
The property is not set if the font size can be increased. See DISPLAY_TRANSFORMABILITY.
-
getBRAILLE
final Accessibility.Feature getBRAILLE()
The content is in braille format, or alternatives are available in braille.
-
getTACTILE_GRAPHIC
final Accessibility.Feature getTACTILE_GRAPHIC()
When used with creative works such as books, indicates that the resource includes tactile graphics. When used to describe an image resource or physical object, indicates that the resource is a tactile graphic.
-
getTACTILE_OBJECT
final Accessibility.Feature getTACTILE_OBJECT()
When used with creative works such as books, indicates that the resource includes models to generate tactile 3D objects. When used to describe a physical object, indicates that the resource is a tactile 3D object.
-
getNONE
final Accessibility.Feature getNONE()
Indicates that the resource does not contain any accessibility features.
-
-
-
-