org.eclipse.tptp.test.auto.gui.internal.core
Interface IUIObject

All Known Implementing Classes:

UIObject

public interface IUIObject

Represents a UI object such as a widget.

Method Summary

void	addChild(IUIObject child) Adds a child to this object.
void	addProperty(java.lang.String name, java.lang.String value) Add a property to this UI object.
int	childCount() Returns the number of children that this UI object has
IUIObject	findChild(java.lang.String referenceId) Returns the child with a matching reference id passed in; null if none is found
IUIObject[]	getChildren() Returns the children of this UI object
java.lang.String	getContextId() Returns the context id of this object
java.lang.Object	getData() Returns the data associated with this object.
java.lang.String	getDescriptive() Returns the descriptive field of this object.
java.util.LinkedList	getHierarchicalRelation() Returns the hierarchical relationshipt of this object relative to its parents.
java.lang.String	getObjectId() Returns the id of this object.
IUIObject	getParent() Returns the parent of this UI object
java.util.Map	getProperties() Returns the properties of this UI object.
java.lang.String	getProperty(java.lang.String name) Returns the property of this object
java.lang.String	getReferenceId() Return the reference id of this object
java.lang.String	getResolverId() Returns the resolver id that has resolved this object
IUIObject	removeChild(IUIObject child) Removes a child from this object
void	setContextId(java.lang.String contextId) Sets the context id of this object
void	setData(java.lang.Object data) Can be used to associate a general data object with this object.
void	setDescriptive(java.lang.String descriptive) Returns the descriptive field of this object.
void	setObjectId(java.lang.String objectId) Sets the id of this object.
void	setParent(IUIObject parent) Set the parent of this UI object
void	setReferenceId(java.lang.String referenceId) Set the reference id of this object.
void	setResolver(java.lang.String resolverId) Sets the resolver id for this object.

Method Detail

getHierarchicalRelation

public java.util.LinkedList getHierarchicalRelation()

Returns the hierarchical relationshipt of this object relative to its parents. A linked list is returned whose first element is the child of the root UI object node and its last node is this UI object. An object directly above a node is the parent of that node.

Returns:

A linked list indicating the hierarchical relationship between this node and its parents.

setReferenceId

public void setReferenceId(java.lang.String referenceId)

Set the reference id of this object.

Parameters:

referenceId - The reference id

getReferenceId

public java.lang.String getReferenceId()

Return the reference id of this object

Returns:

reference id

setContextId

public void setContextId(java.lang.String contextId)

Sets the context id of this object

Parameters:

contextId - The context id of this object

getContextId

public java.lang.String getContextId()

Returns the context id of this object

Returns:

The context id

setObjectId

public void setObjectId(java.lang.String objectId)

Sets the id of this object. This is the id used by the playback operations to identify the UI object.

getObjectId

public java.lang.String getObjectId()

Returns the id of this object. This is the id used by the playback operations to identify the UI object.

Returns:

object id

setDescriptive

public void setDescriptive(java.lang.String descriptive)

Returns the descriptive field of this object. The descriptive field is human readable label that is used to easily recognize the object.

Parameters:

descriptive - field

getDescriptive

public java.lang.String getDescriptive()

Returns the descriptive field of this object. The descriptive field is human readable label that is used to easily recognize the object.

Returns:

descriptive field

addProperty

public void addProperty(java.lang.String name,
                        java.lang.String value)

Add a property to this UI object.

Parameters:

name - The name of the property

value - The value of the property

getProperty

public java.lang.String getProperty(java.lang.String name)

Returns the property of this object

Parameters:

name - The name of the property.

Returns:

The value of the property with the name passed in. null is returned if the property can't be found.

getProperties

public java.util.Map getProperties()

Returns the properties of this UI object.

Returns:

The properties of this UI object

setParent

public void setParent(IUIObject parent)

Set the parent of this UI object

Parameters:

parent - The parent

getParent

public IUIObject getParent()

Returns the parent of this UI object

Returns:

The parent

setResolver

public void setResolver(java.lang.String resolverId)

Sets the resolver id for this object.

Parameters:

resolverId - The resolver id.

getResolverId

public java.lang.String getResolverId()

Returns the resolver id that has resolved this object

Returns:

A resolver id

childCount

public int childCount()

Returns the number of children that this UI object has

Returns:

the number of children of this object

getChildren

public IUIObject[] getChildren()

Returns the children of this UI object

Returns:

The children of this UI object

addChild

public void addChild(IUIObject child)
              throws org.eclipse.core.runtime.CoreException

Adds a child to this object. Has no effects if child is already part of this object's children

Parameters:

child - The child to add

Throws:

org.eclipse.core.runtime.CoreException - In case of any unexpected error

removeChild

public IUIObject removeChild(IUIObject child)

Removes a child from this object

Parameters:

child - The child to remove

Returns:

The child removed

getData

public java.lang.Object getData()

Returns the data associated with this object.

Returns:

The associated data

setData

public void setData(java.lang.Object data)

Can be used to associate a general data object with this object.

Parameters:

data - The data

findChild

public IUIObject findChild(java.lang.String referenceId)

Returns the child with a matching reference id passed in; null if none is found

Parameters:

referenceId - The reference id of the child

Returns:

A IUIObject with a matching referenceId or null if none is found.