Package com.ebasetech.xi.api.controls
Interface AriaControlProperties
- All Known Subinterfaces:
ArticleControl
,AsideControl
,BasicBlockControl
,BootstrapContainerControl
,CanvasControl
,FooterControl
,HeaderControl
,HeadingControl
,HorizontalMenuControl
,HyperlinkControl
,ImageControl
,ListControl
,ListHyperlinkControl
,ListItemControl
,ListPanelControl
,MainControl
,MenuControl
,NavControl
,PanelControl
,RepeatingTableControl
,RepeatingTableListControl
,RepeatingTableListRowControl
,RepeatingTableRowControl
,SectionControl
,TabSetControl
,VerticalMenuControl
public interface AriaControlProperties
-
Method Summary
Modifier and Type Method Description void
addAriaCustomAttribute(java.lang.String name, java.lang.String value)
Add an ARIA custom attribute with a specified name and value.java.lang.String
getAriaCustomAttributes()
Returns a comma separated list of the ARIA custom attributes for the control.AriaHTMLElementIDProperties
getAriaDescribedBy()
Returns the ARIA described-by element ID for the control.AriaHTMLElementIDProperties
getAriaLabelledBy()
Returns the ARIA labelled-by element ID for the control.Text
getAriaLabelText()
Returns theText
object for the ARIA label text.java.lang.String
getAriaRole()
Returns the ARIA role for the control.void
removeAriaCustomAttribute(java.lang.String name)
Remove an ARIA custom attribute specified by name.void
setAriaCustomAttributes(java.lang.String ariaCustomAttributes)
Sets the ARIA custom attributes as a comma separated list associated with the control property and overrides the aria custom attributes value.void
setAriaRole(java.lang.String role)
Sets the ARIA role for the control.
-
Method Details
-
getAriaLabelText
Text getAriaLabelText()Returns theText
object for the ARIA label text.- Since:
- V5.4
-
getAriaRole
java.lang.String getAriaRole()Returns the ARIA role for the control.- Since:
- V5.9
-
setAriaRole
void setAriaRole(java.lang.String role)Sets the ARIA role for the control.- Since:
- V5.9
-
getAriaLabelledBy
AriaHTMLElementIDProperties getAriaLabelledBy()Returns the ARIA labelled-by element ID for the control.- Since:
- V5.9
-
getAriaDescribedBy
AriaHTMLElementIDProperties getAriaDescribedBy()Returns the ARIA described-by element ID for the control.- Since:
- V5.9
-
getAriaCustomAttributes
java.lang.String getAriaCustomAttributes()Returns a comma separated list of the ARIA custom attributes for the control.- Since:
- V5.9
-
setAriaCustomAttributes
void setAriaCustomAttributes(java.lang.String ariaCustomAttributes)Sets the ARIA custom attributes as a comma separated list associated with the control property and overrides the aria custom attributes value.- Parameters:
ariaCustomAttributes
- custom attribute value- Since:
- V5.9
- See Also:
getAriaCustomAttributes()
-
addAriaCustomAttribute
void addAriaCustomAttribute(java.lang.String name, java.lang.String value)Add an ARIA custom attribute with a specified name and value.- Parameters:
name
- attribute namevalue
- attribute value- Since:
- V5.9
- See Also:
getAriaCustomAttributes()
,removeAriaCustomAttribute(String)
-
removeAriaCustomAttribute
void removeAriaCustomAttribute(java.lang.String name)Remove an ARIA custom attribute specified by name.- Parameters:
name
- attribute name- Since:
- V5.9
- See Also:
getAriaCustomAttributes()
,addAriaCustomAttribute(String, String)
-