wt.templateutil.table
Class PDMLinkHTMLTable

java.lang.Object
  wt.templateutil.components.HTMLComponent
      wt.templateutil.components.HTMLTableComponent
          wt.templateutil.table.HTMLTable
              wt.templateutil.table.WTHtmlTable
                  wt.templateutil.table.PDMLinkHTMLTable

All Implemented Interfaces:

CheckBoxColumnAble, HTMLTableColumnModel

Deprecated.

public class PDMLinkHTMLTable
extends WTHtmlTable

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. Subclass of WTHtmlTable that provides the following changes/modifications in addition the existing features of WTHtmlTable

• Uses components specific to the PDMLink (Header, column, and cell)
• Provides "Action Row" at the top of the table with configurable "Multiselect" and "Context Object" links
• Provides sorting of the table based on the order (both increasing and decreasing) of a selected column
• Provides the ability to hide (collapse) one or more columns
• A localized message to be presented in the Table body if there are not any rows to display

In addition, all of the existing TableService script calls can be used with/applied to PDMLinkHTMLTable instances.

It is a requirement that the TableModel used by the PDMLinkHTMLTable implements the AddColumn interface.

Supported API: true

Extendable: false

Field Summary

Fields inherited from class wt.templateutil.components.HTMLTableComponent

BGCOLOR, BORDER, CELLPADDING, CELLSPACING, HEIGHT, HSPACE, VSPACE, WIDTH

Fields inherited from class wt.templateutil.components.HTMLComponent

DEFAULT_SERVICE_NAME, DEFAULTS_ONLY, PRINT_TAG_ATTR, SERVICENAME

Fields inherited from interface wt.templateutil.table.CheckBoxColumnAble

PRESENT_CHECK_BOX

Method Summary

void	createDefaultColumnsFromModel() Deprecated.
void	setIsCollapsingEnabled(boolean isCollapsingEnabled) Deprecated.
void	setIsSortingEnabled(boolean isSortingEnabled) Deprecated.
void	setPresentActionsIconColumn(boolean presentActionsIconColumn) Deprecated.
void	setPresentIconFirstRow(boolean presentIconFirstColumn) Deprecated.
void	setPresentSeeActionsDropDownColumn(boolean presentSeeActionsDropDownColumn) Deprecated. Sets the flag that determines if the "See Actions Column" is to be presented.
String	showSubComponents(Object value, Properties formData, OutputStream os, Locale locale) Deprecated.

Methods inherited from class wt.templateutil.table.WTHtmlTable

isPresentCheckBox, newCheckBoxTableColumn, setPresentCheckBox

Methods inherited from class wt.templateutil.table.HTMLTable

addColumn, addNewColumn, getCellSelector, getColumn, getColumn, getColumnClass, getColumnCount, getColumnIndex, getColumnName, getColumns, getHeaderSelector, getLocale, getMode, getOutputStream, getRowCount, getValueAt, isDisplayHeader, isShowDirect, moveColumn, removeColumn, setCellSelector, setDisplayHeader, setHeaderSelector, setLocale, setMode, setOutputStream, setShowDirect, setTableColumnModel, setTableModel, show, show

Methods inherited from class wt.templateutil.components.HTMLTableComponent

getTag, init, setTagListArray

Methods inherited from class wt.templateutil.components.HTMLComponent

endComponent, getHtmlComponents, getPrintWriter, getServiceName, getTagList, getTagSettings, isInheritStyle, isPrintTagAttributes, isUseDefaultsOnly, main, setInheritStyle, setPrintTagAttributes, setServiceName, setTag, setTagList, setTagListDefaults, setTagSettings, setTagValue, setUseDefaultsOnly, startComponent

Methods inherited from class java.lang.Object

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

Method Detail

createDefaultColumnsFromModel

public void createDefaultColumnsFromModel()

Deprecated.

Initialize the TableColumnModel by instantiating TableColumn subclasses based on

• The Type of the TableModel (TreeTableModel or not)
• Position in the table of the column
• If the checkbox column is to be presented
• If the First column of data is presented

and then adding the TableColumn instances to the TableColumnModel.

By setting the isIconColumnFirst flag to true (default), the first column will be either a TreeTableColumn (if the TableModel is of Type TreeTableModel) or a PDMLinkIconTableColumn.

By setting the isPresentActionsIconColumn to true (default), an ActionsTableColumn column will be added either as the first column (isIconColumnFirst == false) or the second column

Supported API: true

Overrides:

createDefaultColumnsFromModel in class WTHtmlTable

showSubComponents

public String showSubComponents(Object value,
                                Properties formData,
                                OutputStream os,
                                Locale locale)

Deprecated.

Method that actually generates the HTML Table by generating the sections of the HTML Table in the following order (if the section is to be generated).

• The Action Row
• The Table Column Headers
• The Rows in the Body of the HTML table

The generation of the Action Row depends if there is a Multi-Select section or a Context Action Section to be generated.

The display of the Table Column headers can be disabled by setting the isDisplayHeader flag to false.

In the case that there are not any rows to display in the body of the table, the "No Results" message will be presented in the body of the HTML Table.

Supported API: true

Parameters:

value -

formData -

os -

Returns:

locale

setPresentIconFirstRow

public void setPresentIconFirstRow(boolean presentIconFirstColumn)

Deprecated.

Sets the flag that determines if the "First Column" of the HTML table is to be presented.

The HTML Table presents one of two "First Columns"depending on the type of the TableModel

• TreeTableModel - A TreeTableColumn is used to generate the first column to present a Tree of the object's composition
• All other TabelModels - an Icon with a link to the Detail page of the the object being represented in the row (PDMLinkIconTableColumn is used)

The "First Column" is presented at the front of the table and in an additional column to the columns specified in the TableModel.

The default is true.

Supported API: true

Parameters:

presentIconFirstColumn - - sets flag for presenting first column

setPresentActionsIconColumn

public void setPresentActionsIconColumn(boolean presentActionsIconColumn)

Deprecated.

Sets the flag the determines if the "Action Column" is to be presented. The "Action Column" presents a column where each row of the column presents Icons with links to Context Specific actions for the object being represented by that row. For example, if the third row of the HTML Table is presenting information on a checked out document, then the "Action Column" will have a cell with Icons (with links) representing available actions on that document.

The default is true.

Supported API: true

Parameters:

presentActionsIconColumn - - Sets flag that determines if the Action Column is to be presented.

setPresentSeeActionsDropDownColumn

public void setPresentSeeActionsDropDownColumn(boolean presentSeeActionsDropDownColumn)

Deprecated.

Sets the flag that determines if the "See Actions Column" is to be presented. The "See Actions Column" presents a column where each row of the column presents a drop-down list of actions to Context Specific actions for the object being represented by that row.

The default is false.

Supported API: true

Parameters:

presentActionsIconColumn - - Sets flag that determines if the Action Column is to be presented.

setIsSortingEnabled

public void setIsSortingEnabled(boolean isSortingEnabled)

Deprecated.

Sets the flag that tells the HTML Table is sorting on the columns is to be enabled or not. This can be set in HTML Template Processing script calls by calling the enableSorting method on BasicTableService.

Supported API: true

Parameters:

isSortingEnabled - - Sets flag to determine if sorting on the columns is enabled.

setIsCollapsingEnabled

public void setIsCollapsingEnabled(boolean isCollapsingEnabled)

Deprecated.

Sets the flag that tells the HTML Table is hiding(collapsing) on the columns is to be enabled or not. This can be set in HTML Template Processing script calls by calling the enableColumnCollapse method on BasicTableService.

Supported API: true

Parameters:

isCollapsingEnabled - - Sets flag to determine if sorting on the columns is enabled.