wt.templateutil.table
Class ListContentTableService

java.lang.Object
  wt.templateutil.table.ListContentTableService

All Implemented Interfaces:

HTMLTableServiceEventListener

public class ListContentTableService

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 presenting the contents of a ContentHolder. The object the content is retrieved from is the current Context Object of the TemplateProcessor that is processing the HTML page making the Windchill script calls. For example, if we are looking at the properties page for a WTPart, then the Context Object is the WTPart who properties are being displayed. This will also be the object used to retrieve the list of contents from.

The primary function of this service to allow the retrieval of the contents, both UrlData and ApplicationData, and presents the those contents in two Tables. One table for the UrlData and one Table for the ApplicationData. The display characteristics of the tables are separately controlled as is presentation. So the tables can either look the same or they can look different. The tables can be presented one after the other or in different parts of the Page.

Currently, AggregateData is not supported. It will be in the future.

To use ListContentTableService, the following Windchill script call needs to be made

tableService action=initializeContents

After this call, the URLData contents and the ApplicationData contents are available to be displayed. There is a call to initialize the HTMLTable object for each type of content. This allows the two tables to be controlled, both in style and position, separately.

For URLData, the following call initializes a WTHtmlTable to present the URLData

tableService action=initURLDataTable URLDATAATTRIBUTES=urlLocation,description

For ApplicationData, the following call initializes a WTHtmlTable to present the ApplicationData

tableService action=INITAPPLICATIONDATATABLE APPLICATIONDATAATTRIBUTES=fileName,format,fileSize,modifyTimestamp,createdBy


Once these WTHtmlTable are created, the rest of the HTML Table Services are available customize them, as shown below.

An example of using the ListContentTableService is :

<SCRIPT LANGUAGE=Windchill>
<!--
tableService action=initializeContents
tableService action=initURLDataTable URLDATAATTRIBUTES=urlLocation,description
tableService action=setHeaderAttributes name=ALL font.size=2 th.align=left
tableService action=setColumnAttributes name=ALL font.size=2 td.bgcolor=#e3e3cf
tableService action=setTableAttributes table.width=100%
tableService action=show
-->
</SCRIPT>
<SCRIPT LANGUAGE=Windchill>>
<!--
tableService action=INITAPPLICATIONDATATABLE APPLICATIONDATAATTRIBUTES=fileName,format,fileSize,modifyTimestamp,createdBy
tableService action=setHeaderFromResource POSITION=4 RESOURCEBUNDLE=wt.enterprise.enterpriseResource RESOURCEKEY=UPDATED_BY
tableService action=setHeaderAttributes name=ALL font.size=2 th.align=left
tableService action=setColumnAttributes name=ALL font.size=2 td.bgcolor=#e3e3cf
tableService action=setTableAttributes table.width=100%
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.
private Vector	aggregateDataVector Deprecated.
static String	ALL Deprecated.
static String	APPLICATIONDATAATTRIBUTES Deprecated.
private Vector	applicationDataVector Deprecated.
private static String	CLASSNAME Deprecated.
private Object	currentContextHolder Deprecated.
static String	ENTRY_DELIM Deprecated.
static String	FALSE Deprecated.
private HTMLTable	htmlTable Deprecated.
static String	INITAPPLICATIONDATATABLE Deprecated.
static String	INITIALIZECONTENTS Deprecated.
static String	INITURLDATATABLE Deprecated.
static String	NAME_VALUE_DELIM Deprecated.
static String	PDMLINKTABLE Deprecated.
private static String	RESOURCE Deprecated.
private static String	SECONDARY_EXCLUDE Deprecated.
static String	SHOWAPPLICATIONDATA Deprecated.
static String	SHOWURLDATA Deprecated.
static String	SUPPRESS_LINK Deprecated.
protected HTMLTableServiceEvent	tableEvent Deprecated.
static String	URLDATAATTRIBUTES Deprecated.
private Vector	urlDataVector Deprecated.
static String	USECHECKBOXTABLE Deprecated.
private static boolean	VERBOSE Deprecated.

Fields inherited from interface wt.templateutil.table.HTMLTableServiceEventListener

HTML_TABLE

Constructor Summary

ListContentTableService()
Deprecated.

Method Summary

Vector	getAggregateDataVector() Deprecated. Gets the Vector of the AggregateData objects contained in the Context Object.
Vector	getApplicationDataVector() Deprecated. Gets the Vector of the ApplicationData objects contained in the Context Object.
HTMLTable	getHtmlTable() Deprecated.
Vector	getUrlDataVector() Deprecated. Gets the Vector of the URLData objects contained in the Context Object.
void	initApplicationDataTable(Properties props, Locale locale, OutputStream os) Deprecated.
void	initializeContents(Properties props, Locale locale, OutputStream os) Deprecated.
void	initURLDataTable(Properties props, Locale locale, OutputStream os) Deprecated.
void	performAction(Properties props, Locale locale, OutputStream os) Deprecated.
boolean	performHTMLTableAction(HTMLTableServiceEvent tableServiceEvent) Deprecated.
void	setAggregateDataVector(Vector a_AggregateDataVector) Deprecated. Sets the Vector of the AggregateData objects contained in the Context Object.
void	setApplicationDataVector(Vector a_ApplicationDataVector) Deprecated. Sets the Vector of the ApplicationData objects contained in the Context Object.
void	setHtmlTable(HTMLTable a_HtmlTable) Deprecated.
void	setUrlDataVector(Vector a_UrlDataVector) Deprecated. Sets the Vector of the URLData objects contained in the Context Object.
void	showAllContent(Properties props, Locale locale, OutputStream os) Deprecated.
void	showApplicationData(Properties props, Locale locale, OutputStream os) Deprecated.
void	showURLData(Properties props, Locale locale, OutputStream os) 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.

urlDataVector

private Vector urlDataVector

Deprecated.

applicationDataVector

private Vector applicationDataVector

Deprecated.

aggregateDataVector

private Vector aggregateDataVector

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

FALSE

public static final String FALSE

Deprecated.

See Also:

Constant Field Values

SUPPRESS_LINK

public static final String SUPPRESS_LINK

Deprecated.

See Also:

Constant Field Values

USECHECKBOXTABLE

public static final String USECHECKBOXTABLE

Deprecated.

See Also:

Constant Field Values

URLDATAATTRIBUTES

public static final String URLDATAATTRIBUTES

Deprecated.

See Also:

Constant Field Values

APPLICATIONDATAATTRIBUTES

public static final String APPLICATIONDATAATTRIBUTES

Deprecated.

See Also:

Constant Field Values

INITURLDATATABLE

public static final String INITURLDATATABLE

Deprecated.

See Also:

Constant Field Values

INITAPPLICATIONDATATABLE

public static final String INITAPPLICATIONDATATABLE

Deprecated.

See Also:

Constant Field Values

INITIALIZECONTENTS

public static final String INITIALIZECONTENTS

Deprecated.

See Also:

Constant Field Values

SHOWURLDATA

public static final String SHOWURLDATA

Deprecated.

See Also:

Constant Field Values

SHOWAPPLICATIONDATA

public static final String SHOWAPPLICATIONDATA

Deprecated.

See Also:

Constant Field Values

PDMLINKTABLE

public static final String PDMLINKTABLE

Deprecated.

See Also:

Constant Field Values

tableEvent

protected HTMLTableServiceEvent tableEvent

Deprecated.

VERBOSE

private static boolean VERBOSE

Deprecated.

currentContextHolder

private Object currentContextHolder

Deprecated.

SECONDARY_EXCLUDE

private static String SECONDARY_EXCLUDE

Deprecated.

Constructor Detail

ListContentTableService

public ListContentTableService()

Deprecated.

Method Detail

getUrlDataVector

public Vector getUrlDataVector()

Deprecated.

Gets the Vector of the URLData objects contained in the Context Object.

Supported API: false

Returns:

Vector

setUrlDataVector

public void setUrlDataVector(Vector a_UrlDataVector)

Deprecated.

Sets the Vector of the URLData objects contained in the Context Object.

Supported API: false

Parameters:

a_UrlDataVector -

getApplicationDataVector

public Vector getApplicationDataVector()

Deprecated.

Gets the Vector of the ApplicationData objects contained in the Context Object.

Supported API: false

Returns:

Vector

setApplicationDataVector

public void setApplicationDataVector(Vector a_ApplicationDataVector)

Deprecated.

Sets the Vector of the ApplicationData objects contained in the Context Object.

Supported API: false

Parameters:

a_ApplicationDataVector -

getAggregateDataVector

public Vector getAggregateDataVector()

Deprecated.

Gets the Vector of the AggregateData objects contained in the Context Object.

Supported API: false

Returns:

Vector

setAggregateDataVector

public void setAggregateDataVector(Vector a_AggregateDataVector)

Deprecated.

Sets the Vector of the AggregateData objects contained in the Context Object.

Supported API: false

Parameters:

a_AggregateDataVector -

performAction

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

Deprecated.

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

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

The list of valid actions are

• INITIALIZECONTENTS
• INITURLDATATABLE
• INITAPPLICATIONDATATABLE
• SHOWURLDATA
• SHOWAPPLICATIONDATA

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

initURLDataTable

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

Deprecated.

Initializes the WTHtmlTable ( using a RowDataTableModel ) that will be used to generate the table that presents the URLData in the Context Object. The current HTMLTable instance to be used in the HTML Table Service is set to this new WTHtmlTable

The Basic format of the Windchill script call is

tableService action=initURLDataTable URLDATAATTRIBUTES=<Comma separated list of attributes/column handles>

Some additional parameters that can be passed in the Windchill Script call are

• USECHECKBOXTABLE=<true/false> - Indicates whether a checkbox column should be placed at front of the table
• NO_RESULTS_MESSAGE_RESOURCE=<Fully qualified classpath to a ResourceBundle> -
• NO_RESULTS_MESSAGE_KEY=<Name of a Key in the ResouceBundle above> - Key to message to display in the case that there are not any URLData object in the Context Object.

Supported API: true

Parameters:

props -

locale -

os -

Throws:

WTException

showURLData

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

Deprecated.

Supported API: false

Parameters:

props -

locale -

os -

Throws:

WTException

showApplicationData

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

Deprecated.

Supported API: false

Parameters:

props -

locale -

os -

Throws:

WTException

showAllContent

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

Deprecated.

Supported API: false

Parameters:

props -

locale -

os -

Throws:

WTException

initApplicationDataTable

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

Deprecated.

Initializes the WTHtmlTable ( using a RowDataTableModel ) that will be used to generate the table that presents the ApplicationData in the Context Object. The current HTMLTable instance to be used in the HTML Table Service is set to this new WTHtmlTable.

The Basic format of the Windchill script call is

tableService action=initApplicationDataTable APPLICATIONDATAATTRIBUTES=<Comma separated list of attributes/column handles>

Some additional parameters that can be passed in the Windchill Script call are

• USECHECKBOXTABLE=<true/false> - Indicates whether a checkbox column should be placed at front of the table
• NO_RESULTS_MESSAGE_RESOURCE=<Fully qualified classpath to a ResourceBundle> -
• NO_RESULTS_MESSAGE_KEY=<Name of a Key in the ResouceBundle above> - Key to message to display in the case that there are not any ApplicationData object in the Context Object.

Supported API: true

Parameters:

props -

locale -

os -

Throws:

WTException

initializeContents

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

Deprecated.

Initializes the URLData Vector and the ApplicationData Vector from from current Context Object for the TemplateProcessor processing the HTML template from which the Windchill script call was made.

Supported API: true

Parameters:

props -

locale -

os -

Throws:

WTException

getHtmlTable

public HTMLTable getHtmlTable()

Deprecated.

Gets the value of the attribute: htmlTable.

Supported API: true

Specified by:

getHtmlTable in interface HTMLTableServiceEventListener

Returns:

HTMLTable

setHtmlTable

public void setHtmlTable(HTMLTable a_HtmlTable)

Deprecated.

Sets the value of the attribute: htmlTable.

Supported API: true

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