com.ptc.windchill.cadx.common.treetable
Interface TreeTableStructureNavigate

All Known Implementing Classes:

AbstractTreeTableStructureNavigateProcessor

public interface TreeTableStructureNavigate

This class provides methods to get the information about associated objects for the purposes of rendering it in the tree table. For example, one could call the getAssociatedObjects() method to get the usedBy documents for the specified EPMDocument objects

Supported API: false

Extendable: false

Method Summary

Enumeration	getAssociatedObjects(Persistable persistable) For the specified object get the associated objects required for the tree table Supported API: false
Comparator	getComparator(Locale locale) For the specified locale, get the Comparator object.
String	getCookieName() Get the cookie name for the cookie for this class.
Class[]	getNodeObjectValidDataTypes() Get the valid data types of the other (than root) tree table node objects.
Class	getRootObjectValidDataType() Get the data type of the root node of the tree table.

Method Detail

getAssociatedObjects

public Enumeration getAssociatedObjects(Persistable persistable)
                                 throws WTException,
                                        WTPropertyVetoException

For the specified object get the associated objects required for the tree table

Supported API: false

Parameters:

persistable -

Returns:

Enumeration

Throws:

WTException

WTPropertyVetoException

getCookieName

public String getCookieName()

Get the cookie name for the cookie for this class. This cookie contains the session state of the row data objects, table model, row identifier etc.

Supported API: false

Returns:

String

getRootObjectValidDataType

public Class getRootObjectValidDataType()

Get the data type of the root node of the tree table. For example if the root object is EPMDocument, the returned data type would be wt.epm.EPMDocument.class object.

Supported API: false

Returns:

Class

getNodeObjectValidDataTypes

public Class[] getNodeObjectValidDataTypes()

Get the valid data types of the other (than root) tree table node objects. These represent the nodes of the tree. For example if the node objects are EPMDocument, the returned data type would be an array of wt.epm.EPMDocument.class object with only one array element.

Supported API: false

Returns:

Class[]

getComparator

public Comparator getComparator(Locale locale)

For the specified locale, get the Comparator object. This object is later used for sorting of the tree table rows.

Supported API: false

Parameters:

locale -

Returns:

Comparator