com.sencha.gxt.access.client

Class AriaSupport

java.lang.Object

com.sencha.gxt.access.client.AriaSupport

public class AriaSupport
extends Object

ARIA widget support.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescribedBy() Returns the ARIA described by id.
String	getDescription() Returns the description.
String	getLabel() Returns the ARIA label text.
String	getLabelledBy() Returns the ARIA labelled by id.
String	getRole() Returns the ARIA role.
String	getState(String stateName) Returns the ARIA state.
Map<String,String>	getStates() Returns the ARIA states.
boolean	isPresentation() Returns true if the widget is a presentation element.
void	setDescribedBy(String describedBy) Sets the ARIA described by attribute on the widget.
void	setDescription(String description) Sets the ARIA description.
void	setLabel(String label) Sets the ARIA label attribute on the widget.
void	setLabelledBy(String labelledBy) Sets the ARIA labelled by attribute on the widget.
void	setPresentation(boolean presentation) True to mark this widget as a ARIA presentation element.
void	setRole(String role) Sets the ARIA role.
void	setState(String stateName, String value) Sets the ARIA state.

Methods inherited from class java.lang.Object

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

Method Detail

getDescribedBy

public String getDescribedBy()

Returns the ARIA described by id.

Returns:

the ARIA described by id

getDescription

public String getDescription()

Returns the description.

Returns:

the description

getLabel

public String getLabel()

Returns the ARIA label text.

Returns:

the ARIA label text

getLabelledBy

public String getLabelledBy()

Returns the ARIA labelled by id.

Returns:

the ARIA labelled by id.

getRole

public String getRole()

Returns the ARIA role.

Returns:

the ARIA role

getState

public String getState(String stateName)

Returns the ARIA state.

Parameters:

stateName - the state name

Returns:

the state value

getStates

public Map<String,String> getStates()

Returns the ARIA states.

Returns:

the ARIA states

isPresentation

public boolean isPresentation()

Returns true if the widget is a presentation element.

Returns:

true for presentation

setDescribedBy

public void setDescribedBy(String describedBy)

Sets the ARIA described by attribute on the widget.

Parameters:

describedBy - the id of the element with the label

setDescription

public void setDescription(String description)

Sets the ARIA description. This method creates a hidden div, assigns it an id and then sets the aria-describedby value. Should not be called if setDescribedBy(String) is used. This method is useful when there is not an existing element to be used for the description.

Parameters:

description - the description

setLabel

public void setLabel(String label)

Sets the ARIA label attribute on the widget.

Parameters:

label - the label

setLabelledBy

public void setLabelledBy(String labelledBy)

Sets the ARIA labelled by attribute on the widget.

Parameters:

labelledBy - the id of the element with the label

setPresentation

public void setPresentation(boolean presentation)

True to mark this widget as a ARIA presentation element.

Parameters:

presentation - true for presentation

setRole

public void setRole(String role)

Sets the ARIA role.

Parameters:

role - the ARIA role

setState

public void setState(String stateName,
            String value)

Sets the ARIA state.

Parameters:

stateName - the state name

value - the state value