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

Class AbstractRoleWithCommonAttributes

java.lang.Object

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

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

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

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

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

All Implemented Interfaces:

AttributeReadAriaActiveDescendant, AttributeReadAriaAtomic, AttributeReadAriaBusy, AttributeReadAriaChecked, AttributeReadAriaControls, AttributeReadAriaDescribedBy, AttributeReadAriaDisabled, AttributeReadAriaDropEffect, AttributeReadAriaExpanded, AttributeReadAriaFlowTo, AttributeReadAriaGrabbed, AttributeReadAriaHasPopup, AttributeReadAriaHidden, AttributeReadAriaInvalid, AttributeReadAriaLabel, AttributeReadAriaLabelledBy, AttributeReadAriaLevel, AttributeReadAriaLive, AttributeReadAriaOrientation, AttributeReadAriaOwns, AttributeReadAriaReadOnly, AttributeReadAriaRelevant, AttributeReadAriaRequired, AttributeReadAriaSelected, AttributeWriteAriaActiveDescendant, AttributeWriteAriaAtomic, AttributeWriteAriaBusy, AttributeWriteAriaChecked, AttributeWriteAriaControls, AttributeWriteAriaDescribedBy, AttributeWriteAriaDisabled, AttributeWriteAriaDropEffect, AttributeWriteAriaExpanded, AttributeWriteAriaFlowTo, AttributeWriteAriaGrabbed, AttributeWriteAriaHasPopup, AttributeWriteAriaHidden, AttributeWriteAriaInvalid, AttributeWriteAriaLabel, AttributeWriteAriaLabelledBy, AttributeWriteAriaLevel, AttributeWriteAriaLive, AttributeWriteAriaOrientation, AttributeWriteAriaOwns, AttributeWriteAriaReadOnly, AttributeWriteAriaRelevant, AttributeWriteAriaRequired, AttributeWriteAriaSelected, Role, Accessibility

Direct Known Subclasses:

AbstractRoleOption, AbstractRoleRange, AbstractRoleWithCommonAttributesAndAutocomplete, AbstractRoleWithCommonAttributesAndMultiSelectable, RoleHeadingImpl, RoleRadioGroupImpl, RoleRowImpl, RoleSeparatorImpl, RoleTabListImpl

public abstract class AbstractRoleWithCommonAttributes
extends AbstractRoleWithBaseAttributes
implements AttributeWriteAriaChecked, AttributeWriteAriaLevel, AttributeWriteAriaActiveDescendant, AttributeWriteAriaOrientation

This class extends AbstractRoleWithAttributeExpanded with various common ARIA attributes to avoid java multi-inheritance problems. As Roles shall always be accessed via their interface we consider this as implementation secret and expect nobody to bypass the API and access invalid attributes.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private String	activeDescendant
private AriaTristate	checked
private Integer	level
private Orientation	orientation

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

HTML_ATTRIBUTE_ARIA_CHECKED

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

HTML_ATTRIBUTE_ARIA_LEVEL

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

HTML_ATTRIBUTE_ARIA_ACTIVE_DESCENDANT

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

HTML_ATTRIBUTE_ARIA_ORIENTATION

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

WAI_ARIA

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

HTML_ATTRIBUTE_ARIA_READ_ONLY

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

HTML_ATTRIBUTE_ARIA_REQUIRED

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

HTML_ATTRIBUTE_ARIA_SELECTED

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

HTML_ATTRIBUTE_ARIA_EXPANDED

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

Constructor Summary

Constructors

Constructor and Description
AbstractRoleWithCommonAttributes() The constructor.

Method Summary

Modifier and Type	Method and Description
String	getActiveDescendant() This method gets the ID of the active descendant property of this object.
AriaTristate	getChecked() This method gets the checked state of this object.
Integer	getLevel() This method gets the level property of this object.
Orientation	getOrientation() This method gets the orientation property of this object.
void	setActiveDescendant(String id) This method sets the activeDescendant attribute of this object.
void	setChecked(AriaTristate checked) This method sets the checked state of this object.
void	setLevel(Integer level) This method sets the level property of this object.
void	setOrientation(Orientation orientation) This method sets the orientation attribute of this object.
protected void	updateDelegate() This method is called from AbstractRole.setDelegate(AttributeWriteOnlyAttribute) in order to update all attributes on the new delegate.

Methods inherited from class net.sf.mmm.client.ui.base.aria.role.AbstractRoleWithBaseAttributes

isReadOnly, isRequired, setReadOnly, setRequired

Methods inherited from class net.sf.mmm.client.ui.base.aria.role.AbstractRoleWithAttributeExpandedAndSelected

getSelected, setSelected

Methods inherited from class net.sf.mmm.client.ui.base.aria.role.AbstractRoleWithAttributeExpanded

isExpanded, setExpanded

Methods inherited from class net.sf.mmm.client.ui.base.aria.role.AbstractRole

getControls, getDescribedBy, getDropEffect, getFlowTo, getGrabbed, getInvalid, getLabel, getLabelledBy, getLive, getOwns, getRelevant, getRoleInterface, hasPopup, isAtomic, isBusy, isDisabled, isHidden, setAtomic, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBusy, setControls, setControls, setDelegate, setDescribedBy, setDescribedBy, setDisabled, setDropEffect, setFlowTo, setFlowTo, setGrabbed, setHasPopup, setHidden, setInvalid, setLabel, setLabelledBy, setLabelledBy, setLive, setOwns, setOwns, setRelevant

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

checked

private AriaTristate checked

See Also:

getChecked()

level

private Integer level

See Also:

getLevel()

activeDescendant

private String activeDescendant

See Also:

getActiveDescendant()

orientation

private Orientation orientation

See Also:

getOrientation()

Constructor Detail

AbstractRoleWithCommonAttributes

public AbstractRoleWithCommonAttributes()

The constructor.

Method Detail

setChecked

public void setChecked(AriaTristate checked)

This method sets the checked state of this object.

Specified by:

setChecked in interface AttributeWriteAriaChecked

Parameters:

checked - is the new value of AttributeReadAriaChecked.getChecked().

getChecked

public AriaTristate getChecked()

This method gets the checked state of this object.

Specified by:

getChecked in interface AttributeReadAriaChecked

Returns:

the AriaTristate indicating if this object is checked or null if undefined.

getLevel

public Integer getLevel()

This method gets the level property of this object.

Specified by:

getLevel in interface AttributeReadAriaLevel

Returns:

the hierarchical level of this object within its structure or null if undefined.

setLevel

public void setLevel(Integer level)

This method sets the level property of this object.

Specified by:

setLevel in interface AttributeWriteAriaLevel

Parameters:

level - is the new value of AttributeReadAriaLevel.getLevel().

setActiveDescendant

public void setActiveDescendant(String id)

This method sets the activeDescendant attribute of this object.

Specified by:

setActiveDescendant in interface AttributeWriteAriaActiveDescendant

Parameters:

id - is the ID of the activeDescendant or null for none.

getActiveDescendant

public String getActiveDescendant()

This method gets the ID of the active descendant property of this object.

Specified by:

getActiveDescendant in interface AttributeReadAriaActiveDescendant

Returns:

the ID of the active descendant or null if undefined.

getOrientation

public Orientation getOrientation()

This method gets the orientation property of this object.

Specified by:

getOrientation in interface AttributeReadAriaOrientation

Returns:

the Orientation value or null if undefined.

setOrientation

public void setOrientation(Orientation orientation)

This method sets the orientation attribute of this object.

Specified by:

setOrientation in interface AttributeWriteAriaOrientation

Parameters:

orientation - is the new value of AttributeReadAriaOrientation.getOrientation(). May be null to unset.

updateDelegate

protected void updateDelegate()

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

Overrides:

updateDelegate in class AbstractRoleWithBaseAttributes