public interface Role
The ARIA specification defines a hierarchy of roles, which is mirrored here as
a hierarchy of Java interfaces. Some roles are abstract and define methods that are common to
their children. Only concrete roles (available via methods in Roles
) should be used to
modify HTML elements.
For more details, see The Roles Model in the ARIA specification.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAriaAtomicProperty(Element element)
Returns the value of the
aria-atomic attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getAriaBusyState(Element element)
Returns the value of the
aria-busy attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getAriaControlsProperty(Element element)
Returns the value of the
aria-controls attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getAriaDescribedbyProperty(Element element)
Returns the value of the
aria-describedby attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getAriaDisabledState(Element element)
Returns the value of the
aria-disabled attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getAriaDropeffectProperty(Element element)
Returns the value of the
aria-dropeffect attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getAriaFlowtoProperty(Element element)
Returns the value of the
aria-flowto attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getAriaGrabbedState(Element element)
Returns the value of the
aria-grabbed attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getAriaHaspopupProperty(Element element)
Returns the value of the
aria-haspopup attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getAriaHiddenState(Element element)
Returns the value of the
aria-hidden attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getAriaInvalidState(Element element)
Returns the value of the
aria-invalid attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getAriaLabelledbyProperty(Element element)
Returns the value of the
aria-labelledby attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getAriaLabelProperty(Element element)
Returns the value of the
aria-label attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getAriaLiveProperty(Element element)
Returns the value of the
aria-live attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getAriaOwnsProperty(Element element)
Returns the value of the
aria-owns attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getAriaRelevantProperty(Element element)
Returns the value of the
aria-relevant attribute for the
element or "" if no
such attribute is present. |
java.lang.String |
getName()
Gets the ARIA 'role' attribute name as defined in the
WAI-ARIA standard.
|
java.lang.String |
getTabindexExtraAttribute(Element element)
Returns the value of the
tabIndex attribute for the
element or "" if no
such attribute is present. |
void |
remove(Element element)
Removes the 'role' attribute from the
element . |
void |
removeAriaAtomicProperty(Element element)
Removes the
aria-atomic attribute from the
element . |
void |
removeAriaBusyState(Element element)
Removes the
aria-busy attribute from the
element . |
void |
removeAriaControlsProperty(Element element)
Removes the
aria-controls attribute from the
element . |
void |
removeAriaDescribedbyProperty(Element element)
Removes the
aria-describedby attribute from the
element . |
void |
removeAriaDisabledState(Element element)
Removes the
aria-disabled attribute from the
element . |
void |
removeAriaDropeffectProperty(Element element)
Removes the
aria-dropeffect attribute from the
element . |
void |
removeAriaFlowtoProperty(Element element)
Removes the
aria-flowto attribute from the
element . |
void |
removeAriaGrabbedState(Element element)
Removes the
aria-grabbed attribute from the
element . |
void |
removeAriaHaspopupProperty(Element element)
Removes the
aria-haspopup attribute from the
element . |
void |
removeAriaHiddenState(Element element)
Removes the
aria-hidden attribute from the
element . |
void |
removeAriaInvalidState(Element element)
Removes the
aria-invalid attribute from the
element . |
void |
removeAriaLabelledbyProperty(Element element)
Removes the
aria-labelledby attribute from the
element . |
void |
removeAriaLabelProperty(Element element)
Removes the
aria-label attribute from the
element . |
void |
removeAriaLiveProperty(Element element)
Removes the
aria-live attribute from the
element . |
void |
removeAriaOwnsProperty(Element element)
Removes the
aria-owns attribute from the
element . |
void |
removeAriaRelevantProperty(Element element)
Removes the
aria-relevant attribute from the
element . |
void |
removeTabindexExtraAttribute(Element element)
Removes the
tabIndex attribute from the
element . |
void |
set(Element element)
Sets the 'role' attribute of the given
element to the appropriate
value for this role. |
void |
setAriaAtomicProperty(Element element,
boolean value)
|
void |
setAriaBusyState(Element element,
boolean value)
|
void |
setAriaControlsProperty(Element element,
Id... value)
|
void |
setAriaDescribedbyProperty(Element element,
Id... value)
|
void |
setAriaDisabledState(Element element,
boolean value)
|
void |
setAriaDropeffectProperty(Element element,
DropeffectValue... value)
|
void |
setAriaFlowtoProperty(Element element,
Id... value)
|
void |
setAriaGrabbedState(Element element,
GrabbedValue value)
|
void |
setAriaHaspopupProperty(Element element,
boolean value)
|
void |
setAriaHiddenState(Element element,
boolean value)
|
void |
setAriaInvalidState(Element element,
InvalidValue value)
|
void |
setAriaLabelledbyProperty(Element element,
Id... value)
|
void |
setAriaLabelProperty(Element element,
java.lang.String value)
|
void |
setAriaLiveProperty(Element element,
LiveValue value)
|
void |
setAriaOwnsProperty(Element element,
Id... value)
|
void |
setAriaRelevantProperty(Element element,
RelevantValue... value)
|
void |
setTabindexExtraAttribute(Element element,
int value)
|
java.lang.String getAriaAtomicProperty(Element element)
element
or "" if no
such attribute is present.java.lang.String getAriaBusyState(Element element)
element
or "" if no
such attribute is present.java.lang.String getAriaControlsProperty(Element element)
element
or "" if no
such attribute is present.java.lang.String getAriaDescribedbyProperty(Element element)
element
or "" if no
such attribute is present.java.lang.String getAriaDisabledState(Element element)
element
or "" if no
such attribute is present.java.lang.String getAriaDropeffectProperty(Element element)
element
or "" if no
such attribute is present.java.lang.String getAriaFlowtoProperty(Element element)
element
or "" if no
such attribute is present.java.lang.String getAriaGrabbedState(Element element)
element
or "" if no
such attribute is present.java.lang.String getAriaHaspopupProperty(Element element)
element
or "" if no
such attribute is present.java.lang.String getAriaHiddenState(Element element)
element
or "" if no
such attribute is present.java.lang.String getAriaInvalidState(Element element)
element
or "" if no
such attribute is present.java.lang.String getAriaLabelledbyProperty(Element element)
element
or "" if no
such attribute is present.java.lang.String getAriaLabelProperty(Element element)
element
or "" if no
such attribute is present.java.lang.String getAriaLiveProperty(Element element)
element
or "" if no
such attribute is present.java.lang.String getAriaOwnsProperty(Element element)
element
or "" if no
such attribute is present.java.lang.String getAriaRelevantProperty(Element element)
element
or "" if no
such attribute is present.java.lang.String getName()
java.lang.String getTabindexExtraAttribute(Element element)
element
or "" if no
such attribute is present.void remove(Element element)
element
.void removeAriaAtomicProperty(Element element)
element
.void removeAriaBusyState(Element element)
element
.void removeAriaControlsProperty(Element element)
element
.void removeAriaDescribedbyProperty(Element element)
element
.void removeAriaDisabledState(Element element)
element
.void removeAriaDropeffectProperty(Element element)
element
.void removeAriaFlowtoProperty(Element element)
element
.void removeAriaGrabbedState(Element element)
element
.void removeAriaHaspopupProperty(Element element)
element
.void removeAriaHiddenState(Element element)
element
.void removeAriaInvalidState(Element element)
element
.void removeAriaLabelledbyProperty(Element element)
element
.void removeAriaLabelProperty(Element element)
element
.void removeAriaLiveProperty(Element element)
element
.void removeAriaOwnsProperty(Element element)
element
.void removeAriaRelevantProperty(Element element)
element
.void removeTabindexExtraAttribute(Element element)
element
.void set(Element element)
element
to the appropriate
value for this role.void setAriaAtomicProperty(Element element, boolean value)
void setAriaBusyState(Element element, boolean value)
void setAriaDisabledState(Element element, boolean value)
void setAriaDropeffectProperty(Element element, DropeffectValue... value)
void setAriaGrabbedState(Element element, GrabbedValue value)
void setAriaHaspopupProperty(Element element, boolean value)
void setAriaHiddenState(Element element, boolean value)
void setAriaInvalidState(Element element, InvalidValue value)
void setAriaLabelProperty(Element element, java.lang.String value)
void setAriaRelevantProperty(Element element, RelevantValue... value)
void setTabindexExtraAttribute(Element element, int value)