org.gnu.atk

Class AtkObject

public class AtkObject extends GObject

This class is the primary class for accessibility support via the Accessibility TookKit (ATK). Objects which are instances of AtkObject are queried for properties which relate basic properties of a UI component such as name and description.

Constructor Summary
	AtkObject(Handle handle) Construct a new AtkObject using the handle returned by a call to the native layer.

Method Summary
boolean	addRelationship(RelationType type, AtkObject target) Adds a relationship of the specified type with the specified target.
static AtkObject	getAtkObjectFromHandle(Handle hndl) Static factory method that should only be used interally by Java-Gnome.
AtkObject	getChild(int index) Returns the specified child of the object.
String	getDescription() Gets the accessible description of the accessible.
int	getIndexInParent() Get the index of the accessible in its parent.
Layer	getLayer() Get the Layer of the accessible.
String	getLocalizedRoleName(Role role) Get the localized description describing the Role
int	getMDIZorder() Get the zorder of the accessible.
String	getName() Gets the accessible name of the accessible.
int	getNumChildren() Returns the number of accessible children of the accessible.
AtkObject	getParent() Get the accessible parent of the accessible.
Role	getRole() Gets the role of the accessible.
Role	getRoleForName(String name) Get the role corresponding to the name.
String	getRoleName(Role role) Get the description describing the Role.
boolean	removeRelationship(RelationType type, AtkObject target) Removes a relationship of the specified type with the specified target.
void	setDescription(String description) Sets the accessible description of the accessible.
void	setName(String name) Sets the accessible name of the accessible.
void	setParent(AtkObject parent) Sets the accessible parent of the accessible.
void	setRole(Role role) Sets the role of the accessible.

Constructor Detail

AtkObject

public AtkObject(Handle handle)

Construct a new AtkObject using the handle returned by a call to the native layer.

Parameters: handle The handle to the native resource.

Method Detail

addRelationship

public boolean addRelationship(RelationType type, AtkObject target)

Adds a relationship of the specified type with the specified target.

Parameters: type target

getAtkObjectFromHandle

public static AtkObject getAtkObjectFromHandle(Handle hndl)

Static factory method that should only be used interally by Java-Gnome.

getChild

public AtkObject getChild(int index)

Returns the specified child of the object. The index is 0 based.

Parameters: index The position of the child starting at 0.

Returns: An AtkObject that is the child at the specified position.

getDescription

public String getDescription()

Gets the accessible description of the accessible.

Returns: A string representing the accessible description of the accessible.

getIndexInParent

public int getIndexInParent()

Get the index of the accessible in its parent. Returns -1 if the accessible does not have an accessible parent.

getLayer

public Layer getLayer()

Get the Layer of the accessible.

getLocalizedRoleName

public String getLocalizedRoleName(Role role)

Get the localized description describing the Role

Parameters: role

getMDIZorder

public int getMDIZorder()

Get the zorder of the accessible.

getName

public String getName()

Gets the accessible name of the accessible.

Returns: A string representing the accessible name of the accessible.

getNumChildren

public int getNumChildren()

Returns the number of accessible children of the accessible.

Returns: the number of accessible children.

getParent

public AtkObject getParent()

Get the accessible parent of the accessible.

Returns: An AtkObject representing the accessible parent of the accessible.

getRole

public Role getRole()

Gets the role of the accessible.

Returns: A Role which is the role of the accessible.

getRoleForName

public Role getRoleForName(String name)

Get the role corresponding to the name.

Parameters: name

getRoleName

public String getRoleName(Role role)

Get the description describing the Role.

Parameters: role

removeRelationship

public boolean removeRelationship(RelationType type, AtkObject target)

Removes a relationship of the specified type with the specified target.

Parameters: type target

setDescription

public void setDescription(String description)

Sets the accessible description of the accessible.

Parameters: description The accessible description.

setName

public void setName(String name)

Sets the accessible name of the accessible.

Parameters: name The accessible name.

setParent

public void setParent(AtkObject parent)

Sets the accessible parent of the accessible.

Parameters: parent The accessible parent.

setRole

public void setRole(Role role)

Sets the role of the accessible.

Parameters: role The role to be set.