wt.templateutil.table
Class AssociationListTableService

java.lang.Object
  wt.templateutil.table.AssociationListTableService

All Implemented Interfaces:

HTMLTableServiceEventListener

public class AssociationListTableService

extends Object

implements HTMLTableServiceEventListener

Deprecation Notice: This class is still valid for this release, however this serves as advance notice that it will be removed in the future. All user interfaces built using the Windchill HTML Template Processing client architecture will be rewritten using a different framework in an upcoming release.

This is a implementation of an HTML Table Service that provides special support for working with an AssociationTableModel and the WTHtmlTable.

The primary function of this service to allow the specification of an association navigation to be done and presents the results of that navigation in a Table.

The type of navigation to be done can be specified in the Windchill script calls. The columns to present for both BinaryLinks and the OtherSide objects can be specified in the Windchill script. A direct call to a navigation can be done or a subclass of the BaseQueryService can be used to perform the navigation. The direct call to a navigation is the default unless a reference to a subclass of the BaseQueryService is passed in the initAssociationNavigation call.

An example of using the AssociationListTableService that does a Straight Navigation and presents the results is :

<SCRIPT LANGUAGE=Windchill> <BR> <!--
tableService action=initAssociationNavigation ROLE=uses LINKCLASSNAME=wt.part.WTPartUsageLink OTHERSIDECLASS=wt.part.WTPartMaster
tableService action=initAssociationTable othersideattributes=name,number,type linkattributes=modifyTimestamp,quantity
tableService action=setHeaderAttributes COLUMNNUMBER=ALL th.ALIGN=left font.COLOR=blue font.size=1
tableService action=setColumnAttributes name=number,quantity td.ALIGN=left nowrap font.size=5
tableService action=setTableAttributes table.ALIGN=center table.WIDTH=90% table.cellspacing=2 table.cellpadding=2 table.border=4
tableService action=show
-->
</SCRIPT>


An example of using the AssociationListTableService that uses a subclass of BaseQueryService and presents the results is :

<SCRIPT LANGUAGE=Windchill>
<!--
tableService action=initAssociationNavigation BASEQUERYSERVICE=RelevantChangeables ROLE=theChangeable2 LINKCLASSNAME=wt.change2.RelevantAnalysisData OTHERSIDECLASS=wt.change2.Changeable2
tableService action=setAssociationTable ASSOCIATIONTABLE=wt.change2.htmlclient.ChangeableAssociationTable
tableService action=initAssociationTable OtherSideAttributes=number,name,versionInfo,type,source
tableService action=setHeaderAttributes COLUMNNUMBER=ALL th.ALIGN=left font.COLOR=white font.size=2
tableService action=setColumnAttributes COLUMNNUMBER=ALL td.ALIGN=left nowrap font.size=2
tableService action=setTableAttributes table.ALIGN=left table.WIDTH=90% table.cellspacing=2 table.cellpadding=2
tableService action=show
-->
</SCRIPT>


There might be some line wrapping in the text above. All proper Windchill script lines above should begin with tableService.

Supported API: true

Extendable: false

Field Summary

static String	ACTION Deprecated.
static String	ALL Deprecated.
private AssociationsLogic	associationsLogic Deprecated.
private HTMLTable	associationTable Deprecated.
private AssociationTableModel	associationTableModel Deprecated.
private static String	CLASSNAME Deprecated.
static String	ENTRY_DELIM Deprecated.
static String	FALSE Deprecated.
private HTMLTable	htmlTable Deprecated.
static String	INITASSOCIATIONNAVIGATION Deprecated.
static String	INITASSOCIATIONTABLE Deprecated.
private boolean	isAssociationsLogicClean Deprecated.
private boolean	isAssociationTableModelClean Deprecated.
private boolean	isHTMLTableClean Deprecated.
static String	LINKATTRIBUTES Deprecated.
static String	NAME Deprecated.
static String	NAME_VALUE_DELIM Deprecated.
static String	OTHERSIDEATTRIBUTES Deprecated.
static String	PDMLINKTABLE Deprecated.
private QueryResult	queryResult Deprecated.
private static String	RESOURCE Deprecated.
private Vector	results Deprecated.
private Vector	resultVector Deprecated.
static String	SETASSOCIATIONTABLE Deprecated.
static String	SETASSOCIATIONTABLEMODEL Deprecated.
static String	SETLINKCHECKBOXCOLUMN Deprecated.
static String	SETLINKROWCONTEXTOBJECT Deprecated.
static String	SUPPRESS_HEADER Deprecated.
static String	SUPPRESS_ICON Deprecated.
static String	SUPPRESS_LINK Deprecated.
private String	tableContext Deprecated.
protected HTMLTableServiceEvent	tableEvent Deprecated.
static String	USECHECKBOXTABLE Deprecated.
private static boolean	VERBOSE Deprecated.

Fields inherited from interface wt.templateutil.table.HTMLTableServiceEventListener

HTML_TABLE

Constructor Summary

AssociationListTableService()
Deprecated.

Method Summary

AssociationsLogic	getAssociationsLogic() Deprecated. Gets the current AssociationsLogic instance being used.
HTMLTable	getAssociationTable() Deprecated. Gets the current HTMLTable subclass.
AssociationTableModel	getAssociationTableModel() Deprecated. Gets the current subclass of AssociationTableModel set.
HTMLTable	getHtmlTable() Deprecated. Gets the current HTMLTable subclass being used Supported API: false
QueryResult	getQueryResult() Deprecated. Gets the current value of the queryResult parameter
Vector	getResults() Deprecated. Gets the Vector of results of the navigation is a subclass of BaseQueryService was used.
String	getTableContext() Deprecated.
Vector	getVectorResults() Deprecated.
void	initAssociationNavigation(Properties props, Locale locale, OutputStream os) Deprecated.
void	initAssociationTable(Properties props, Locale locale, OutputStream os) Deprecated.
void	performAction(Properties props, Locale locale, OutputStream os) Deprecated.
boolean	performHTMLTableAction(HTMLTableServiceEvent tableServiceEvent) Deprecated.
void	setAssociationsLogic(AssociationsLogic newAssociationsLogic) Deprecated. Sets the current AssociationsLogic instance being used.
void	setAssociationTable(HTMLTable newAssociationTable) Deprecated. Sets the current HTMLTable subclass.
void	setAssociationTable(Properties props, Locale locale, OutputStream os) Deprecated. Sets the WTHtmlTable subclass to use.
void	setAssociationTableModel(AssociationTableModel newAssociationTableModel) Deprecated. Sets the subclass of AssociationTableModel to be used in generating the Table.
void	setAssociationTableModel(Properties props, Locale locale, OutputStream os) Deprecated. Sets the AssociationTableModel subclass to use.
void	setHtmlTable(HTMLTable a_HtmlTable) Deprecated. Sets the HTMLTable subclass to be used Supported API: false
void	setLinkCheckboxColumn(Properties props, Locale locale, OutputStream os) Deprecated.
void	setLinkRowContextObject(Properties props, Locale locale, OutputStream os) Deprecated.
void	setQueryResult(QueryResult qr) Deprecated. Sets the QueryResult of the navigation in initAssociationNavigation.
void	setResults(Vector a_result) Deprecated. Sets the results Vector from the navigation done in initAssociationNavigation is the navigation returned an Array ( used when a subclass of BaseQueryService was used ).
void	setTableContext(String newContext) Deprecated.
void	setVectorResults(Vector newResultVector) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

Deprecated.

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Deprecated.

htmlTable

private HTMLTable htmlTable

Deprecated.

ACTION

public static final String ACTION

Deprecated.

See Also:

Constant Field Values

ENTRY_DELIM

public static final String ENTRY_DELIM

Deprecated.

See Also:

Constant Field Values

NAME_VALUE_DELIM

public static final String NAME_VALUE_DELIM

Deprecated.

See Also:

Constant Field Values

ALL

public static final String ALL

Deprecated.

See Also:

Constant Field Values

INITASSOCIATIONTABLE

public static final String INITASSOCIATIONTABLE

Deprecated.

See Also:

Constant Field Values

INITASSOCIATIONNAVIGATION

public static final String INITASSOCIATIONNAVIGATION

Deprecated.

See Also:

Constant Field Values

SETASSOCIATIONTABLEMODEL

public static final String SETASSOCIATIONTABLEMODEL

Deprecated.

See Also:

Constant Field Values

SETASSOCIATIONTABLE

public static final String SETASSOCIATIONTABLE

Deprecated.

See Also:

Constant Field Values

SETLINKCHECKBOXCOLUMN

public static final String SETLINKCHECKBOXCOLUMN

Deprecated.

See Also:

Constant Field Values

SETLINKROWCONTEXTOBJECT

public static final String SETLINKROWCONTEXTOBJECT

Deprecated.

See Also:

Constant Field Values

LINKATTRIBUTES

public static final String LINKATTRIBUTES

Deprecated.

See Also:

Constant Field Values

OTHERSIDEATTRIBUTES

public static final String OTHERSIDEATTRIBUTES

Deprecated.

See Also:

Constant Field Values

USECHECKBOXTABLE

public static final String USECHECKBOXTABLE

Deprecated.

See Also:

Constant Field Values

PDMLINKTABLE

public static final String PDMLINKTABLE

Deprecated.

See Also:

Constant Field Values

NAME

public static final String NAME

Deprecated.

See Also:

Constant Field Values

SUPPRESS_HEADER

public static final String SUPPRESS_HEADER

Deprecated.

See Also:

Constant Field Values

FALSE

public static final String FALSE

Deprecated.

See Also:

Constant Field Values

SUPPRESS_ICON

public static final String SUPPRESS_ICON

Deprecated.

See Also:

Constant Field Values

SUPPRESS_LINK

public static final String SUPPRESS_LINK

Deprecated.

See Also:

Constant Field Values

VERBOSE

private static final boolean VERBOSE

Deprecated.

tableEvent

protected HTMLTableServiceEvent tableEvent

Deprecated.

queryResult

private QueryResult queryResult

Deprecated.

resultVector

private Vector resultVector

Deprecated.

results

private Vector results

Deprecated.

tableContext

private String tableContext

Deprecated.

associationTable

private HTMLTable associationTable

Deprecated.

isHTMLTableClean

private boolean isHTMLTableClean

Deprecated.

associationTableModel

private AssociationTableModel associationTableModel

Deprecated.

isAssociationTableModelClean

private boolean isAssociationTableModelClean

Deprecated.

associationsLogic

private AssociationsLogic associationsLogic

Deprecated.

isAssociationsLogicClean

private boolean isAssociationsLogicClean

Deprecated.

Constructor Detail

AssociationListTableService

public AssociationListTableService()

Deprecated.

Method Detail

performAction

public void performAction(Properties props,
                          Locale locale,
                          OutputStream os)
                   throws WTException

Deprecated.

Performs the action defined by the value of the key AssociationListTableService.ACTION in the props parameter.

If either props == null or there is not a value for AssociationListTableService.ACTION, an exception is thrown.

The list of valid actions are

• INITASSOCIATIONTABLE
• INITASSOCIATIONNAVIGATION
• SETASSOCIATIONTABLEMODEL
• SETASSOCIATIONTABLE

For the requirements/details of the individual methods, please see the javadoc for those methods directly.

Supported API: true

Parameters:

props -

locale -

os -

Throws:

WTException

initAssociationTable

public void initAssociationTable(Properties props,
                                 Locale locale,
                                 OutputStream os)
                          throws WTException

Deprecated.

Initializes the AssociationTableModel that will drive the table by using the results of the navigation done in initAssociationNavigation and initializing the AssociationTableModel based on the settings of the navigation and the results of the navigation

The Basic format of the Windchill script call is

tableService action=initAssociationTable othersideattributes=<Comma separated list of attributes/column handles> linkattributes=<Comma separated list of attributes/column handles>

The following name/value pairs can be set in the props parameter.

• LINKATTRIBUTES - comma separated list of names/handles for the BinaryLink columns
• OTHERSIDEATTRIBUTES - comma separated list of names/handles for the OtherSide object columns
• USECHECKBOXTABLE - true/false indicating whether to have the first column be a checkbox column
• NO_RESULTS_MESSAGE_KEY - Name of the Static String in a the Resoucre Bundle passed in NO_RESULTS_MESSAGE_RESOURCE
• NO_RESULTS_MESSAGE_RESOURCE - Name of the Resource Bundle to use with the NO_RESULTS_MESSAGE_KEY

It is assumed by the AssociationTableModel that the comma separated list of names/handles is a list of attributes for either the BinaryLink objects ( LINKATTRIBUTES ) or the OtherSide objects ( OTHERSIDEATTRIBUTES ). The names/handles do not have to attribute on those classes.

Supported API: true

Parameters:

props -

locale -

os -

Throws:

WTException

initAssociationNavigation

public void initAssociationNavigation(Properties props,
                                      Locale locale,
                                      OutputStream os)
                               throws WTException

Deprecated.

Performs an association navigation based on the values passed in the props parameter.

The Basic format of the Windchill script call is

tableService action=initAssociationNavigation ROLE=<...> LINKCLASSNAME=<...> OTHERSIDECLASS=<...>

The following name/value pairs MUST be set in the props parameter or an exception will occur

• "ROLE" - The Role of the OtherSide object class
• "LINKCLASSNAME" - The fully qualified class name of the BinaryLinks used to navigate
• "OTHERSIDECLASS" - The fully qualified class name of the OtherSide objects in the BinaryLinks

Some optional parameters that can be passed in are

• "BASEQUERYSERVICE" - This can be the fully qualified class name of subclass of wt.enterprise.tabularresults.BaseQueryService or simply the name of the class(if the subclass is code generated)
• "USEMASTER" - Use the Master of the current Context Object in performing the navigation

The results of the navigation are passed to the initNavigationTable method to initialize the the AssociationTableModel.

Supported API: true

Parameters:

props -

locale -

os -

Throws:

WTException

setLinkCheckboxColumn

public void setLinkCheckboxColumn(Properties props,
                                  Locale locale,
                                  OutputStream os)

Deprecated.

Changes the checkbox to use the link object for it's context.

The Basic format of the Windchill script call is

tableService action=setLinkCheckboxColumn

Supported API: false

Parameters:

props -

locale -

os -

setLinkRowContextObject

public void setLinkRowContextObject(Properties props,
                                    Locale locale,
                                    OutputStream os)

Deprecated.

Changes the row context object to use the link object. The Basic format of the Windchill script call is

tableService action=setLinkRowContextObject

Supported API: false

Parameters:

props -

locale -

os -

getHtmlTable

public HTMLTable getHtmlTable()

Deprecated.

Gets the current HTMLTable subclass being used

Supported API: false

Specified by:

getHtmlTable in interface HTMLTableServiceEventListener

Returns:

HTMLTable

setHtmlTable

public void setHtmlTable(HTMLTable a_HtmlTable)

Deprecated.

Sets the HTMLTable subclass to be used

Supported API: false

Specified by:

setHtmlTable in interface HTMLTableServiceEventListener

Parameters:

a_HtmlTable -

performHTMLTableAction

public boolean performHTMLTableAction(HTMLTableServiceEvent tableServiceEvent)
                               throws WTException

Deprecated.

Peform the action defined by action parameter in the Windchill script call

tableSdrvice action=...

if that action is supported by this HTMLTableServiceEventListener. If that action is not supported, simply return with a return value of false.

Supported API: true

Specified by:

performHTMLTableAction in interface HTMLTableServiceEventListener

Parameters:

tableServiceEvent -

Returns:

boolean

Throws:

WTException

setQueryResult

public void setQueryResult(QueryResult qr)

Deprecated.

Sets the QueryResult of the navigation in initAssociationNavigation. This occurs if the navigation is done without using a subclass of BaseQueryService

Parameters:

qr -

getQueryResult

public QueryResult getQueryResult()

Deprecated.

Gets the current value of the queryResult parameter

Returns:

QueryResult

setResults

public void setResults(Vector a_result)

Deprecated.

Sets the results Vector from the navigation done in initAssociationNavigation is the navigation returned an Array ( used when a subclass of BaseQueryService was used ). The array must be a of type wt.fc.BinaryLink.

Parameters:

a_result -

getResults

public Vector getResults()

Deprecated.

Gets the Vector of results of the navigation is a subclass of BaseQueryService was used.

Returns:

Vector

setTableContext

public void setTableContext(String newContext)

Deprecated.

getTableContext

public String getTableContext()

Deprecated.

setAssociationTableModel

public void setAssociationTableModel(Properties props,
                                     Locale locale,
                                     OutputStream os)
                              throws WTException

Deprecated.

Sets the AssociationTableModel subclass to use.

The value of the "ASSOCIATIONTABLEMODEL" key in the props parameter must be the fully qualified class name of a subclass of AssociationTableModel (or AssociationTableModel itself) otherwise an exception will be thrown.

Supported API: true

Parameters:

props -

locale -

os -

Throws:

WTException

setAssociationTable

public void setAssociationTable(Properties props,
                                Locale locale,
                                OutputStream os)
                         throws WTException

Deprecated.

Sets the WTHtmlTable subclass to use.

The value of the "ASSOCIATIONTABLE" key in the props parameter must be the fully qualified class name of a subclass of WTHtmlTable (or WTHtmlTable itself) otherwise an exception will be thrown.

Supported API: true

Parameters:

props -

locale -

os -

Throws:

WTException

getAssociationTableModel

public AssociationTableModel getAssociationTableModel()

Deprecated.

Gets the current subclass of AssociationTableModel set. If the AssociationTableModel to use has not been set, then lazy initialization is done and an instance of AssociationTableModel is returned.

Returns:

AssociationTableModel

setAssociationTableModel

public void setAssociationTableModel(AssociationTableModel newAssociationTableModel)

Deprecated.

Sets the subclass of AssociationTableModel to be used in generating the Table.

Supported API: true

getAssociationTable

public HTMLTable getAssociationTable()

Deprecated.

Gets the current HTMLTable subclass. This is actually required to be a subclass of WTHtmlTable

Returns:

HTMLTable

setAssociationTable

public void setAssociationTable(HTMLTable newAssociationTable)

Deprecated.

Sets the current HTMLTable subclass. This is actually required to be a subclass of WTHtmlTable

Supported API: true

Parameters:

newAssociationTable -

getAssociationsLogic

public AssociationsLogic getAssociationsLogic()

Deprecated.

Gets the current AssociationsLogic instance being used. This instance is shared between the initAssociationNavigation method and the initAssociationTable method

Returns:

AssociationsLogic

setAssociationsLogic

public void setAssociationsLogic(AssociationsLogic newAssociationsLogic)

Deprecated.

Sets the current AssociationsLogic instance being used. This instance is shared between the initAssociationNavigation method and the initAssociationTable method

Parameters:

newAssociationsLogic -

setVectorResults

public void setVectorResults(Vector newResultVector)

Deprecated.

getVectorResults

public Vector getVectorResults()

Deprecated.