ice.pilots.html4
Class AccessibleContextProxy

java.lang.Object
  javax.accessibility.AccessibleContext
      ice.pilots.html4.AccessibleContextProxy

public abstract class AccessibleContextProxy

extends AccessibleContext

AccessibleContextProxy is an abstract class that allows clients to to delegate calls to a different AccessibleContext and only override methods they choose.

Version:

$Name: v6_1_2 $ ($Revision: 1.1.2.1 $) $Date: 2004/02/02 21:28:37 $

Author:

Frank Beier (fbeier@us.oracle.com)

Field Summary

Fields inherited from class javax.accessibility.AccessibleContext

ACCESSIBLE_ACTION_PROPERTY, ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY, ACCESSIBLE_CARET_PROPERTY, ACCESSIBLE_CHILD_PROPERTY, ACCESSIBLE_DESCRIPTION_PROPERTY, ACCESSIBLE_HYPERTEXT_OFFSET, ACCESSIBLE_NAME_PROPERTY, ACCESSIBLE_SELECTION_PROPERTY, ACCESSIBLE_STATE_PROPERTY, ACCESSIBLE_TABLE_CAPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED, ACCESSIBLE_TABLE_MODEL_CHANGED, ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_ROW_HEADER_CHANGED, ACCESSIBLE_TABLE_SUMMARY_CHANGED, ACCESSIBLE_TEXT_PROPERTY, ACCESSIBLE_VALUE_PROPERTY, ACCESSIBLE_VISIBLE_DATA_PROPERTY, accessibleDescription, accessibleName, accessibleParent

Constructor Summary

AccessibleContextProxy()

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener) Add a PropertyChangeListener to the listener list.
void	firePropertyChange(String propertyName, Object oldValue, Object newValue) Support for reporting bound property changes.
AccessibleAction	getAccessibleAction() Get the AccessibleAction associated with this object that supports one or more actions.
Accessible	getAccessibleChild(int i) Return the specified Accessible child of the object.
int	getAccessibleChildrenCount() Returns the number of accessible children of the object.
AccessibleComponent	getAccessibleComponent() Get the AccessibleComponent associated with this object that has a graphical representation.
protected abstract AccessibleContext	getAccessibleContext() Clients must override this method to return the AccessibleContext to delegate to.
String	getAccessibleDescription() Get the accessibleDescription property of this object.
int	getAccessibleIndexInParent() Get the 0-based index of this object in its accessible parent.
String	getAccessibleName() Get the accessibleName property of this object.
Accessible	getAccessibleParent() Get the Accessible parent of this object.
AccessibleRole	getAccessibleRole() Get the role of this object.
AccessibleSelection	getAccessibleSelection() Get the AccessibleSelection associated with this object which allows its Accessible children to be selected.
AccessibleStateSet	getAccessibleStateSet() Get the state set of this object.
AccessibleText	getAccessibleText() Get the AccessibleText associated with this object presently editable text on the display.
AccessibleValue	getAccessibleValue() Get the AccessibleValue associated with this object that supports a Numerical value.
Locale	getLocale() Gets the locale of the component.
void	removePropertyChangeListener(PropertyChangeListener listener) Remove a PropertyChangeListener from the listener list.
void	setAccessibleDescription(String s) Set the accessible description of this object.
void	setAccessibleName(String s) Set the localized accessible name of this object.
void	setAccessibleParent(Accessible a) Set the Accessible parent of this object.

Methods inherited from class javax.accessibility.AccessibleContext

getAccessibleEditableText, getAccessibleIcon, getAccessibleRelationSet, getAccessibleTable

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessibleContextProxy

public AccessibleContextProxy()

Method Detail

getAccessibleName

public String getAccessibleName()

Get the accessibleName property of this object. The accessibleName property of an object is a localized String that designates the purpose of the object. For example, the accessibleName property of a label or button might be the text of the label or button itself. In the case of an object that doesn't display its name, the accessibleName should still be set. For example, in the case of a text field used to enter the name of a city, the accessibleName for the en_US locale could be 'city.'

Returns:

the localized name of the object; null if this object does not have a name

See Also:

setAccessibleName(java.lang.String)

setAccessibleName

public void setAccessibleName(String s)

Set the localized accessible name of this object. Changing the name will cause a PropertyChangeEvent to be fired for the ACCESSIBLE_NAME_PROPERTY property.

Parameters:

s - the new localized name of the object.

See Also:

getAccessibleName(), addPropertyChangeListener(java.beans.PropertyChangeListener)

getAccessibleDescription

public String getAccessibleDescription()

Get the accessibleDescription property of this object. The accessibleDescription property of this object is a short localized phrase describing the purpose of the object. For example, in the case of a 'Cancel' button, the accessibleDescription could be 'Ignore changes and close dialog box.'

Returns:

the localized description of the object; null if this object does not have a description

See Also:

setAccessibleDescription(java.lang.String)

setAccessibleDescription

public void setAccessibleDescription(String s)

Set the accessible description of this object. Changing the name will cause a PropertyChangeEvent to be fired for the ACCESSIBLE_DESCRIPTION_PROPERTY property.

Parameters:

s - the new localized description of the object

See Also:

setAccessibleName(java.lang.String), addPropertyChangeListener(java.beans.PropertyChangeListener)

getAccessibleRole

public AccessibleRole getAccessibleRole()

Get the role of this object. The role of the object is the generic purpose or use of the class of this object. For example, the role of a push button is AccessibleRole.PUSH_BUTTON. The roles in AccessibleRole are provided so component developers can pick from a set of predefined roles. This enables assistive technologies to provide a consistent interface to various tweaked subclasses of components (e.g., use AccessibleRole.PUSH_BUTTON for all components that act like a push button) as well as distinguish between sublasses that behave differently (e.g., AccessibleRole.CHECK_BOX for check boxes and AccessibleRole.RADIO_BUTTON for radio buttons).

Note that the AccessibleRole class is also extensible, so custom component developers can define their own AccessibleRole's if the set of predefined roles is inadequate.

Returns:

an instance of AccessibleRole describing the role of the object

See Also:

AccessibleRole

getAccessibleStateSet

public AccessibleStateSet getAccessibleStateSet()

Get the state set of this object. The AccessibleStateSet of an object is composed of a set of unique AccessibleState's. A change in the AccessibleStateSet of an object will cause a PropertyChangeEvent to be fired for the ACCESSIBLE_STATE_PROPERTY property.

Returns:

an instance of AccessibleStateSet containing the current state set of the object

See Also:

AccessibleStateSet, AccessibleState, addPropertyChangeListener(java.beans.PropertyChangeListener)

getAccessibleParent

public Accessible getAccessibleParent()

Get the Accessible parent of this object.

Returns:

the Accessible parent of this object; null if this object does not have an Accessible parent

setAccessibleParent

public void setAccessibleParent(Accessible a)

Set the Accessible parent of this object. This is meant to be used only in the situations where the actual component's parent should not be treated as the component's accessible parent and is a method that should only be called by the parent of the accessible child.

Parameters:

a - - Accessible to be set as the parent

getAccessibleIndexInParent

public int getAccessibleIndexInParent()

Get the 0-based index of this object in its accessible parent.

Returns:

the 0-based index of this object in its parent; -1 if this object does not have an accessible parent.

See Also:

getAccessibleParent(), getAccessibleChildrenCount(), getAccessibleChild(int)

getAccessibleChildrenCount

public int getAccessibleChildrenCount()

Returns the number of accessible children of the object.

Returns:

the number of accessible children of the object.

getAccessibleChild

public Accessible getAccessibleChild(int i)

Return the specified Accessible child of the object. The Accessible children of an Accessible object are zero-based, so the first child of an Accessible child is at index 0, the second child is at index 1, and so on.

Parameters:

i - zero-based index of child

Returns:

the Accessible child of the object

See Also:

getAccessibleChildrenCount()

getLocale

public Locale getLocale()
                 throws IllegalComponentStateException

Gets the locale of the component. If the component does not have a locale, then the locale of its parent is returned.

Returns:

This component's locale. If this component does not have a locale, the locale of its parent is returned.

Throws:

IllegalComponentStateException - If the Component does not have its own locale and has not yet been added to a containment hierarchy such that the locale can be determined from the containing parent.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Add a PropertyChangeListener to the listener list. The listener is registered for all Accessible properties and will be called when those properties change.

Parameters:

listener - The PropertyChangeListener to be added

See Also:

AccessibleContext.ACCESSIBLE_NAME_PROPERTY, AccessibleContext.ACCESSIBLE_DESCRIPTION_PROPERTY, AccessibleContext.ACCESSIBLE_STATE_PROPERTY, AccessibleContext.ACCESSIBLE_VALUE_PROPERTY, AccessibleContext.ACCESSIBLE_SELECTION_PROPERTY, AccessibleContext.ACCESSIBLE_TEXT_PROPERTY, AccessibleContext.ACCESSIBLE_VISIBLE_DATA_PROPERTY

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.

Parameters:

listener - The PropertyChangeListener to be removed

getAccessibleAction

public AccessibleAction getAccessibleAction()

Get the AccessibleAction associated with this object that supports one or more actions.

Returns:

AccessibleAction if supported by object; else return null

See Also:

AccessibleAction

getAccessibleComponent

public AccessibleComponent getAccessibleComponent()

Get the AccessibleComponent associated with this object that has a graphical representation.

Returns:

AccessibleComponent if supported by object; else return null

See Also:

AccessibleComponent

getAccessibleSelection

public AccessibleSelection getAccessibleSelection()

Get the AccessibleSelection associated with this object which allows its Accessible children to be selected.

Returns:

AccessibleSelection if supported by object; else return null

See Also:

AccessibleSelection

getAccessibleText

public AccessibleText getAccessibleText()

Get the AccessibleText associated with this object presently editable text on the display.

Returns:

AccessibleText if supported by object; else return null

See Also:

AccessibleText

getAccessibleValue

public AccessibleValue getAccessibleValue()

Get the AccessibleValue associated with this object that supports a Numerical value.

Returns:

AccessibleValue if supported by object; else return null

See Also:

AccessibleValue

firePropertyChange

public void firePropertyChange(String propertyName,
                               Object oldValue,
                               Object newValue)

Support for reporting bound property changes. If oldValue and newValue are not equal and the PropertyChangeEvent listener list is not empty, then fire a PropertyChange event to each listener. In general, this is for use by the Accessible objects themselves and should not be called by an application program.

Parameters:

propertyName - The programmatic name of the property that was changed.

oldValue - The old value of the property.

newValue - The new value of the property.

See Also:

PropertyChangeSupport, addPropertyChangeListener(java.beans.PropertyChangeListener), removePropertyChangeListener(java.beans.PropertyChangeListener), AccessibleContext.ACCESSIBLE_NAME_PROPERTY, AccessibleContext.ACCESSIBLE_DESCRIPTION_PROPERTY, AccessibleContext.ACCESSIBLE_STATE_PROPERTY, AccessibleContext.ACCESSIBLE_VALUE_PROPERTY, AccessibleContext.ACCESSIBLE_SELECTION_PROPERTY, AccessibleContext.ACCESSIBLE_TEXT_PROPERTY, AccessibleContext.ACCESSIBLE_VISIBLE_DATA_PROPERTY

getAccessibleContext

protected abstract AccessibleContext getAccessibleContext()

Clients must override this method to return the AccessibleContext to delegate to.