org.safs.jvmagent
Class ContainerAgent

java.lang.Object
  |
  +--org.safs.jvmagent.ObjectAgent
        |
        +--org.safs.jvmagent.ComponentAgent
              |
              +--org.safs.jvmagent.ContainerAgent

All Implemented Interfaces:

AlternateAncestorUser, LocalAgent, LocalAgentFactoryUser

Direct Known Subclasses:

ContainerAgent, JComponentAgent, WindowAgent

public class ContainerAgent

extends ComponentAgent

Field Summary

static java.lang.String[]	CONTAINER_PROPERTIES Array of property names specific to Container types.
static java.lang.String	objectType "Container" (Subclasses will override) The generic object type supported by this Agent helper class.

Fields inherited from class org.safs.jvmagent.ComponentAgent

COMPONENT_PROPERTIES

Fields inherited from class org.safs.jvmagent.ObjectAgent

alternateAncestor, alternateAncestorClassname, factory, OBJECT_PROPERTIES

Constructor Summary

ContainerAgent()
Constructor for ContainerAgent.

Method Summary

int	getChildCount(java.lang.Object object) Return the number of children available in the provided parent.
java.lang.Object[]	getChildren(java.lang.Object object) Return an array representing the children of the provided parent object.
java.lang.String	getProperty(java.lang.Object object, java.lang.String property) Retrieve the property value of the object if the object has the property.
java.lang.String[]	getPropertyNames(java.lang.Object object) Retrieve the list of available properties for the object.

Methods inherited from class org.safs.jvmagent.ComponentAgent

validateActionCommand, validateComponent

Methods inherited from class org.safs.jvmagent.ObjectAgent

getAlternateAncestor, getAlternateAncestorClassname, getAncestorAgent, getCaption, getClassName, getID, getLevel, getLocalAgentFactory, getMatchingPathObject, getName, getStringData, getSuperClassNames, getText, isMatchingPath, isShowing, isValid, process, processAncestor, setAlternateAncestor, setAlternateAncestorClassname, setLocalAgentFactory

Methods inherited from class java.lang.Object

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

Field Detail

objectType

public static final java.lang.String objectType

"Container" (Subclasses will override) The generic object type supported by this Agent helper class. The generic object type is that returned by GuiClassData.getGenericObjectType. Example: Component Button Table etc..

See Also:

GuiClassData.getGenericObjectType(String)

CONTAINER_PROPERTIES

public static final java.lang.String[] CONTAINER_PROPERTIES

Array of property names specific to Container types.

0. childCount
1. insets
2. .childCount

Subclasses will have additional property names in other named arrays. The full set of property names is received with a call to getPropertyNames();

See Also:

getPropertyNames(Object)

Constructor Detail

ContainerAgent

public ContainerAgent()

Constructor for ContainerAgent.

Method Detail

getChildCount

public int getChildCount(java.lang.Object object)

Description copied from interface: LocalAgent

Return the number of children available in the provided parent.

Overrides:

getChildCount in class ObjectAgent

See Also:

LocalAgent.getChildCount(Object)

getChildren

public java.lang.Object[] getChildren(java.lang.Object object)

Description copied from interface: LocalAgent

Return an array representing the children of the provided parent object.

Overrides:

getChildren in class ObjectAgent

See Also:

LocalAgent.getChildren(Object)

getPropertyNames

public java.lang.String[] getPropertyNames(java.lang.Object object)

Description copied from interface: LocalAgent

Retrieve the list of available properties for the object.

Overrides:

getPropertyNames in class ComponentAgent

Parameters:

object - -- the actual object or component to be checked -- not a pseudo reference.

Returns:

ALL_PROPERTIES

See Also:

LocalAgent.getPropertyNames(Object)

getProperty

public java.lang.String getProperty(java.lang.Object object,
                                    java.lang.String property)
                             throws NoSuchPropertyException

Description copied from interface: LocalAgent

Retrieve the property value of the object if the object has the property.

Overrides:

getProperty in class ComponentAgent

Parameters:

object - -- the actual object or component to be checked -- not a pseudo reference.

property - -- case-sensitive name of the property to retrieve

Returns:

property value which may be null

Throws:

NoSuchPropertyException -

See Also:

LocalAgent.getProperty(Object, String)