net.sf.mmm.client.ui.base.aria.role

Class AbstractRole

java.lang.Object

net.sf.mmm.client.ui.base.aria.role.AbstractRole

All Implemented Interfaces:

AttributeReadAriaAtomic, AttributeReadAriaBusy, AttributeReadAriaControls, AttributeReadAriaDescribedBy, AttributeReadAriaDisabled, AttributeReadAriaDropEffect, AttributeReadAriaFlowTo, AttributeReadAriaGrabbed, AttributeReadAriaHasPopup, AttributeReadAriaHidden, AttributeReadAriaInvalid, AttributeReadAriaLabel, AttributeReadAriaLabelledBy, AttributeReadAriaLive, AttributeReadAriaOwns, AttributeReadAriaRelevant, AttributeWriteAriaAtomic, AttributeWriteAriaBusy, AttributeWriteAriaControls, AttributeWriteAriaDescribedBy, AttributeWriteAriaDisabled, AttributeWriteAriaDropEffect, AttributeWriteAriaFlowTo, AttributeWriteAriaGrabbed, AttributeWriteAriaHasPopup, AttributeWriteAriaHidden, AttributeWriteAriaInvalid, AttributeWriteAriaLabel, AttributeWriteAriaLabelledBy, AttributeWriteAriaLive, AttributeWriteAriaOwns, AttributeWriteAriaRelevant, Role, Accessibility

Direct Known Subclasses:

AbstractRoleComposite, AbstractRoleWithAttributeChecked, AbstractRoleWithAttributeExpanded, RoleMenuItemImpl, RolePresentationImpl

public abstract class AbstractRole
extends Object
implements Role

This is the implementation of Role.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	atomic
private boolean	busy
private AriaIdList	controls
private AttributeWriteOnlyAttribute	delegate
private AriaIdList	describedBy
private boolean	disabled
private AriaDropEffect	dropEffect
private static AriaIdList	EMPTY_ID_LIST The empty AriaIdList.
private AriaIdList	flowTo
private Boolean	grabbed
private boolean	hasPopup
private boolean	hidden
private AriaInvalid	invalid
private String	label
private AriaIdList	labelledBy
private AriaLiveLevel	live
private AriaIdList	owns
private AriaChangeNotifications	relevant

Fields inherited from interface net.sf.mmm.client.ui.api.aria.role.Role

ARIA_ROLE_ALERT, ARIA_ROLE_ALERT_DIALOG, ARIA_ROLE_APPLICATION, ARIA_ROLE_ARTICLE, ARIA_ROLE_BANNER, ARIA_ROLE_BUTTON, ARIA_ROLE_CHECKBOX, ARIA_ROLE_COLUMN_HEADER, ARIA_ROLE_COMBOBOX, ARIA_ROLE_COMPLEMENTARY, ARIA_ROLE_COMPOSITE, ARIA_ROLE_CONTENT_INFO, ARIA_ROLE_DEFINITION, ARIA_ROLE_DIALOG, ARIA_ROLE_DIRECTORY, ARIA_ROLE_DOCUMENT, ARIA_ROLE_FORM, ARIA_ROLE_GRID, ARIA_ROLE_GRID_CELL, ARIA_ROLE_GROUP, ARIA_ROLE_HEADING, ARIA_ROLE_IMG, ARIA_ROLE_LANDMARK, ARIA_ROLE_LINK, ARIA_ROLE_LIST, ARIA_ROLE_LIST_ITEM, ARIA_ROLE_LISTBOX, ARIA_ROLE_LOG, ARIA_ROLE_MAIN, ARIA_ROLE_MARQUEE, ARIA_ROLE_MATH, ARIA_ROLE_MENU, ARIA_ROLE_MENU_BAR, ARIA_ROLE_MENU_ITEM, ARIA_ROLE_MENU_ITEM_CHECKBOX, ARIA_ROLE_MENU_ITEM_RADIO, ARIA_ROLE_NAVIGATION, ARIA_ROLE_NOTE, ARIA_ROLE_OPTION, ARIA_ROLE_PRESENTATION, ARIA_ROLE_PROGRESS_BAR, ARIA_ROLE_RADIO, ARIA_ROLE_RADIO_GROUP, ARIA_ROLE_REGION, ARIA_ROLE_ROW, ARIA_ROLE_ROW_GROUP, ARIA_ROLE_ROW_HEADER, ARIA_ROLE_SCROLLBAR, ARIA_ROLE_SEARCH, ARIA_ROLE_SECTION_HEAD, ARIA_ROLE_SEPARATOR, ARIA_ROLE_SLIDER, ARIA_ROLE_SPIN_BUTTON, ARIA_ROLE_STATUS, ARIA_ROLE_TAB, ARIA_ROLE_TAB_LIST, ARIA_ROLE_TAB_PANEL, ARIA_ROLE_TEXTBOX, ARIA_ROLE_TIMER, ARIA_ROLE_TOOLBAR, ARIA_ROLE_TOOLTIP, ARIA_ROLE_TREE, ARIA_ROLE_TREE_GRID, ARIA_ROLE_TREE_ITEM, HTML_ATTRIBUTE_ARIA_ROLE

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaAtomic

HTML_ATTRIBUTE_ARIA_ATOMIC

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaBusy

HTML_ATTRIBUTE_ARIA_BUSY

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaControls

HTML_ATTRIBUTE_ARIA_CONTROLS

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaDescribedBy

HTML_ATTRIBUTE_ARIA_DESCRIBED_BY

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaDisabled

HTML_ATTRIBUTE_ARIA_DISABLED

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaDropEffect

HTML_ATTRIBUTE_ARIA_DROP_EFFECT

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaFlowTo

HTML_ATTRIBUTE_ARIA_FLOW_TO

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaGrabbed

HTML_ATTRIBUTE_ARIA_GRABBED

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaHasPopup

HTML_ATTRIBUTE_ARIA_HAS_POPUP

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaHidden

HTML_ATTRIBUTE_ARIA_HIDDEN

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaInvalid

HTML_ATTRIBUTE_ARIA_INVALID

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaLabel

HTML_ATTRIBUTE_ARIA_LABEL

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaLabelledBy

HTML_ATTRIBUTE_ARIA_LABELLED_BY

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaLive

HTML_ATTRIBUTE_ARIA_LIVE

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaOwns

HTML_ATTRIBUTE_ARIA_OWNS

Fields inherited from interface net.sf.mmm.client.ui.api.aria.attribute.AttributeReadAriaRelevant

HTML_ATTRIBUTE_ARIA_RELEVANT

Fields inherited from interface net.sf.mmm.util.lang.api.concern.Accessibility

WAI_ARIA

Constructor Summary

Constructors

Constructor and Description
AbstractRole() The constructor.

Method Summary

Modifier and Type	Method and Description
AriaIdList	getControls() This method gets the ID of the controls property of this object.
AriaIdList	getDescribedBy() This method gets the ID of the describedby property of this object.
AriaDropEffect	getDropEffect() This method gets the dropeffect property of this object.
AriaIdList	getFlowTo() This method gets the ID of the flowto property of this object.
Boolean	getGrabbed() This method gets the value of the grabbed state of this object.
AriaInvalid	getInvalid() This method gets the invalid state of this object.
String	getLabel() This method gets the label property of this object.
AriaIdList	getLabelledBy() This method gets the ID of the labelledby property of this object.
AriaLiveLevel	getLive() This method gets the live property of this object.
AriaIdList	getOwns() This method gets the ID of the owns property of this object.
AriaChangeNotifications	getRelevant() This method gets the relevant property of this object.
abstract Class<? extends Role>	getRoleInterface()
boolean	hasPopup() This method gets the value of the haspopup property of this object.
boolean	isAtomic() This method gets the value of the atomic property of this object.
boolean	isBusy() This method gets the value of the busy state of this object.
boolean	isDisabled() This method gets the value of the disabled state of this object.
boolean	isHidden() This method gets the hidden state of this object.
void	setAtomic(boolean atomic) This method sets the atomic property of this object.
protected void	setAttribute(String name, boolean flag)
protected void	setAttribute(String name, Boolean flag)
protected void	setAttribute(String name, Datatype datatype)
protected void	setAttribute(String name, Number number)
protected void	setAttribute(String name, String value)
void	setBusy(boolean busy) This method sets the busy state of this object.
void	setControls(AriaIdList controls) This method sets the controls attribute of this object.
void	setControls(String controls) This method sets the controls attribute of this object.
void	setDelegate(AttributeWriteOnlyAttribute delegate)
void	setDescribedBy(AriaIdList describedBy) This method sets the describedBy attribute of this object.
void	setDescribedBy(String describedBy) This method sets the describedBy attribute of this object.
void	setDisabled(boolean disabled) This method sets the disabled state of this object.
void	setDropEffect(AriaDropEffect dropEffect) This method sets the dropEffect attribute of this object.
void	setFlowTo(AriaIdList flowTo) This method sets the flowTo attribute of this object.
void	setFlowTo(String flowTo) This method sets the flowTo attribute of this object.
void	setGrabbed(Boolean grabbed) This method sets the grabbed state of this object.
void	setHasPopup(boolean hasPopup) This method sets the hasPopup property of this object.
void	setHidden(boolean hidden) This method sets the hidden attribute of this object.
void	setInvalid(AriaInvalid invalid) This method sets the invalid state of this object.
void	setLabel(String label) This method sets the label property of this object.
void	setLabelledBy(AriaIdList labelledBy) This method sets the labelledBy attribute of this object.
void	setLabelledBy(String labelledBy) This method sets the labelledBy attribute of this object.
void	setLive(AriaLiveLevel live) This method sets the live attribute of this object.
void	setOwns(AriaIdList owns) This method sets the owns attribute of this object.
void	setOwns(String owns) This method sets the owns attribute of this object.
void	setRelevant(AriaChangeNotifications relevant) This method sets the relevant attribute of this object.
protected void	updateDelegate() This method is called from setDelegate(AttributeWriteOnlyAttribute) in order to update all attributes on the new delegate.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.client.ui.api.aria.role.Role

getName

Field Detail

EMPTY_ID_LIST

private static final AriaIdList EMPTY_ID_LIST

The empty AriaIdList.

delegate

private AttributeWriteOnlyAttribute delegate

See Also:

setAttribute(String, String)

atomic

private boolean atomic

See Also:

isAtomic()

busy

private boolean busy

See Also:

isBusy()

controls

private AriaIdList controls

See Also:

getControls()

describedBy

private AriaIdList describedBy

See Also:

getDescribedBy()

disabled

private boolean disabled

See Also:

isDisabled()

dropEffect

private AriaDropEffect dropEffect

See Also:

getDropEffect()

flowTo

private AriaIdList flowTo

See Also:

getFlowTo()

grabbed

private Boolean grabbed

See Also:

getGrabbed()

hasPopup

private boolean hasPopup

See Also:

hasPopup()

hidden

private boolean hidden

See Also:

isHidden()

invalid

private AriaInvalid invalid

See Also:

getInvalid()

label

private String label

See Also:

getLabel()

labelledBy

private AriaIdList labelledBy

See Also:

getLabelledBy()

live

private AriaLiveLevel live

See Also:

getLive()

owns

private AriaIdList owns

See Also:

getOwns()

relevant

private AriaChangeNotifications relevant

See Also:

getRelevant()

Constructor Detail

AbstractRole

public AbstractRole()

The constructor.

Method Detail

getRoleInterface

public abstract Class<? extends Role> getRoleInterface()

Returns:

the Role-Interface corresponding to this instance.

setDelegate

public final void setDelegate(AttributeWriteOnlyAttribute delegate)

Parameters:

delegate - is the delegate where attributes are set.

updateDelegate

protected void updateDelegate()

This method is called from setDelegate(AttributeWriteOnlyAttribute) in order to update all attributes on the new delegate.

setAttribute

protected final void setAttribute(String name,
                                  Datatype datatype)

Parameters:

name - is the name of the attribute.

datatype - is the value to set as a Datatype.

See Also:

AttributeWriteOnlyAttribute.setAttribute(String, String)

setAttribute

protected final void setAttribute(String name,
                                  Number number)

Parameters:

name - is the name of the attribute.

number - is the value to set as a Number.

See Also:

AttributeWriteOnlyAttribute.setAttribute(String, String)

setAttribute

protected final void setAttribute(String name,
                                  Boolean flag)

Parameters:

name - is the name of the attribute.

flag - is the value to set as a Boolean.

See Also:

AttributeWriteOnlyAttribute.setAttribute(String, String)

setAttribute

protected final void setAttribute(String name,
                                  boolean flag)

Parameters:

name - is the name of the attribute.

flag - is the value to set as boolean.

See Also:

AttributeWriteOnlyAttribute.setAttribute(String, String)

setAttribute

protected final void setAttribute(String name,
                                  String value)

Parameters:

name - is the name of the attribute.

value - is the value to set. May be null to unset.

See Also:

AttributeWriteOnlyAttribute.setAttribute(String, String)

setAtomic

public void setAtomic(boolean atomic)

This method sets the atomic property of this object.

Specified by:

setAtomic in interface AttributeWriteAriaAtomic

Parameters:

atomic - is the new value of AttributeReadAriaAtomic.isAtomic().

isAtomic

public boolean isAtomic()

This method gets the value of the atomic property of this object.

Specified by:

isAtomic in interface AttributeReadAriaAtomic

Returns:

the atomic state. true if assistive technologies should present the entire region as a whole, false if a change within the region may be processed by the assistive technologies on its own. The default (if NOT set) is false.

setBusy

public void setBusy(boolean busy)

This method sets the busy state of this object.

Specified by:

setBusy in interface AttributeWriteAriaBusy

Parameters:

busy - is the new value of AttributeReadAriaBusy.isBusy().

isBusy

public boolean isBusy()

This method gets the value of the busy state of this object.

Specified by:

isBusy in interface AttributeReadAriaBusy

Returns:

the busy state. The default (if NOT set) is false.

setControls

public void setControls(AriaIdList controls)

This method sets the controls attribute of this object.

Specified by:

setControls in interface AttributeWriteAriaControls

Parameters:

controls - is value of AttributeReadAriaControls.getControls(). May be null to unset.

setControls

public void setControls(String controls)

This method sets the controls attribute of this object.

Specified by:

setControls in interface AttributeWriteAriaControls

Parameters:

controls - is value of AttributeReadAriaControls.getControls() as String. May be null or the empty string to unset.

getControls

public AriaIdList getControls()

This method gets the ID of the controls property of this object.

Specified by:

getControls in interface AttributeReadAriaControls

Returns:

the AriaIdList of the controls. Will be the an empty AriaIdList if undefined.

setDescribedBy

public void setDescribedBy(AriaIdList describedBy)

This method sets the describedBy attribute of this object.

Specified by:

setDescribedBy in interface AttributeWriteAriaDescribedBy

Parameters:

describedBy - is value of AttributeReadAriaDescribedBy.getDescribedBy(). May be null to unset.

setDescribedBy

public void setDescribedBy(String describedBy)

This method sets the describedBy attribute of this object.

Specified by:

setDescribedBy in interface AttributeWriteAriaDescribedBy

Parameters:

describedBy - is value of AttributeReadAriaDescribedBy.getDescribedBy() as String. May be null or the empty string to unset.

getDescribedBy

public AriaIdList getDescribedBy()

This method gets the ID of the describedby property of this object.

Specified by:

getDescribedBy in interface AttributeReadAriaDescribedBy

Returns:

the AriaIdList of objects that describe this object. Will be the empty AriaIdList if undefined.

setDisabled

public void setDisabled(boolean disabled)

This method sets the disabled state of this object.

Specified by:

setDisabled in interface AttributeWriteAriaDisabled

Parameters:

disabled - is the new value of AttributeReadAriaDisabled.isDisabled().

isDisabled

public boolean isDisabled()

This method gets the value of the disabled state of this object.

Specified by:

isDisabled in interface AttributeReadAriaDisabled

Returns:

the disabled state. true if this object and all its focusable descendants are disabled so the end-user cannot change their value, false otherwise (default).

setDropEffect

public void setDropEffect(AriaDropEffect dropEffect)

This method sets the dropEffect attribute of this object.

Specified by:

setDropEffect in interface AttributeWriteAriaDropEffect

Parameters:

dropEffect - is the new value of AttributeReadAriaDropEffect.getDropEffect(). May be null to unset (for none).

getDropEffect

public AriaDropEffect getDropEffect()

This method gets the dropeffect property of this object. This property is specified as a list of tokens but many combinations such as copy and move do not make sense. Therefore we defined combinations in AriaDropEffect rather than returning a list of AriaDropEffects.

Specified by:

getDropEffect in interface AttributeReadAriaDropEffect

Returns:

the AriaDropEffect value. The default (if NOT set) is AriaDropEffect.NONE.

setFlowTo

public void setFlowTo(AriaIdList flowTo)

This method sets the flowTo attribute of this object.

Specified by:

setFlowTo in interface AttributeWriteAriaFlowTo

Parameters:

flowTo - is value of AttributeReadAriaFlowTo.getFlowTo(). May be null to unset.

setFlowTo

public void setFlowTo(String flowTo)

This method sets the flowTo attribute of this object.

Specified by:

setFlowTo in interface AttributeWriteAriaFlowTo

Parameters:

flowTo - is value of AttributeReadAriaFlowTo.getFlowTo() as String. May be null or the empty string to unset.

getFlowTo

public AriaIdList getFlowTo()

This method gets the ID of the flowto property of this object.

Specified by:

getFlowTo in interface AttributeReadAriaFlowTo

Returns:

the AriaIdList of the next objects in alternate reading order. Will be the empty AriaIdList if undefined.

setGrabbed

public void setGrabbed(Boolean grabbed)

This method sets the grabbed state of this object.

Specified by:

setGrabbed in interface AttributeWriteAriaGrabbed

Parameters:

grabbed - is the new value of AttributeReadAriaGrabbed.getGrabbed(). May be null.

getGrabbed

public Boolean getGrabbed()

This method gets the value of the grabbed state of this object.

Specified by:

getGrabbed in interface AttributeReadAriaGrabbed

Returns:

true if the object has been "grabbed" for dragging, false if the object supports being dragged (but is not currently grabbed), null if the object does not support being dragged (default).

setHasPopup

public void setHasPopup(boolean hasPopup)

This method sets the hasPopup property of this object.

Specified by:

setHasPopup in interface AttributeWriteAriaHasPopup

Parameters:

hasPopup - is the new value of AttributeReadAriaHasPopup.hasPopup().

hasPopup

public boolean hasPopup()

This method gets the value of the haspopup property of this object.

Specified by:

hasPopup in interface AttributeReadAriaHasPopup

Returns:

true if this object has a popup context menu or sub-level menu, false otherwise. The default (if NOT set) is false.

setHidden

public void setHidden(boolean hidden)

This method sets the hidden attribute of this object.

Specified by:

setHidden in interface AttributeWriteAriaHidden

Parameters:

hidden - is the new value of AttributeReadAriaHidden.isHidden().

See Also:

AttributeReadAriaHidden.isHidden()

isHidden

public boolean isHidden()

This method gets the hidden state of this object. It indicates whether the object and all of its descendants are not visible or perceivable to any user.

Specified by:

isHidden in interface AttributeReadAriaHidden

Returns:

true if the object is hidden, false if it is visible for assistive technologies.

See Also:

AttributeReadVisible.isVisible()

setInvalid

public void setInvalid(AriaInvalid invalid)

This method sets the invalid state of this object.

Specified by:

setInvalid in interface AttributeWriteAriaInvalid

Parameters:

invalid - is the new value of AttributeReadAriaInvalid.getInvalid().

getInvalid

public AriaInvalid getInvalid()

This method gets the invalid state of this object.

Specified by:

getInvalid in interface AttributeReadAriaInvalid

Returns:

the AriaInvalid indicating if the validation state of this object. The default (if NOT set) is AriaInvalid.FALSE.

setLabel

public void setLabel(String label)

This method sets the label property of this object.

Specified by:

setLabel in interface AttributeWriteAriaLabel

Parameters:

label - is the new value of AttributeReadAriaLabel.getLabel().

getLabel

public String getLabel()

This method gets the label property of this object.

Specified by:

getLabel in interface AttributeReadAriaLabel

Returns:

the label or null if undefined.

See Also:

AttributeReadLabel.getLabel()

setLabelledBy

public void setLabelledBy(AriaIdList labelledBy)

This method sets the labelledBy attribute of this object.

Specified by:

setLabelledBy in interface AttributeWriteAriaLabelledBy

Parameters:

labelledBy - is value of AttributeReadAriaLabelledBy.getLabelledBy(). May be null to unset.

setLabelledBy

public void setLabelledBy(String labelledBy)

This method sets the labelledBy attribute of this object.

Specified by:

setLabelledBy in interface AttributeWriteAriaLabelledBy

Parameters:

labelledBy - is value of AttributeReadAriaLabelledBy.getLabelledBy() as String. May be null or the empty string to unset.

getLabelledBy

public AriaIdList getLabelledBy()

This method gets the ID of the labelledby property of this object.

Specified by:

getLabelledBy in interface AttributeReadAriaLabelledBy

Returns:

the AriaIdList of IDs of objects that label this object. Will be the empty AriaIdList if undefined.

setLive

public void setLive(AriaLiveLevel live)

This method sets the live attribute of this object.

Specified by:

setLive in interface AttributeWriteAriaLive

Parameters:

live - is the new value of AttributeReadAriaLive.getLive(). May be null to unset.

getLive

public AriaLiveLevel getLive()

This method gets the live property of this object.

Specified by:

getLive in interface AttributeReadAriaLive

Returns:

the AriaLiveLevel. The default (if NOT set) is AriaLiveLevel.OFF.

setOwns

public void setOwns(AriaIdList owns)

This method sets the owns attribute of this object.

Specified by:

setOwns in interface AttributeWriteAriaOwns

Parameters:

owns - is value of AttributeReadAriaOwns.getOwns(). May be null to unset.

setOwns

public void setOwns(String owns)

This method sets the owns attribute of this object.

Specified by:

setOwns in interface AttributeWriteAriaOwns

Parameters:

owns - is value of AttributeReadAriaOwns.getOwns() as String. May be null or the empty string to unset.

getOwns

public AriaIdList getOwns()

This method gets the ID of the owns property of this object.

Specified by:

getOwns in interface AttributeReadAriaOwns

Returns:

the AriaIdList of objects owned by this object. Will be the empty AriaIdList if undefined.

setRelevant

public void setRelevant(AriaChangeNotifications relevant)

This method sets the relevant attribute of this object.

Specified by:

setRelevant in interface AttributeWriteAriaRelevant

Parameters:

relevant - is the new value of AttributeReadAriaRelevant.getRelevant(). May be null to unset.

getRelevant

public AriaChangeNotifications getRelevant()

This method gets the relevant property of this object. As this property is specified by a list of tokens but some tokens themselves represent combinations we mapped this to a single enum AriaChangeNotifications that covers all combinations rather than a list of the enum.

Specified by:

getRelevant in interface AttributeReadAriaRelevant

Returns:

the AriaChangeNotifications value or null if undefined.