wt.templateutil.table
Class HTMLTable

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

All Implemented Interfaces:

HTMLTableColumnModel

Direct Known Subclasses:

ActionBarHTMLTable, AdHocActivitiesHTMLTable, AttributeHTMLTable, ExpandableTable, NavigationBarHTMLTable, SignatureTable, WTHtmlTable

public class HTMLTable

extends HTMLTableComponent

implements HTMLTableColumnModel

The base class that generates tables from implementations of TableModels. It works with the HTMLTableColumns and an implementation of an HTMLTableColumnModel to control the generation of the HTML table.

There are several ways to customize and/or configure the HTMLTable to control the presentation of the table that is generated by the HTMLTable. The following three ways are currently available:

• Configuring the HTMLTable via fields on the HTMLTable as follows:
  • Setting the cellSelector to look for custom HTML components to render the cell.
  • Setting the headerSelector to look for custom HTML components to render the header.
  • Setting the displayHeader field to show or hide the table headers.
• Overriding behavior by subclassing the following:
  • createDefaultColumnsFromModel
  • printHeaders
  • printRow
• Using the HTML table service
  

For more information see the customizer's guide.

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.

Supported API: true

Extendable: false

Field Summary

private String	cellSelector Deprecated.
private static String	CLASSNAME Deprecated.
private HTMLComponentFactory	componentFactory Deprecated.
protected static String	DEFAULT_TABLE_CELL_ID_VALUE Deprecated.
private boolean	displayHeader Deprecated.
private static boolean	encodeValuesForHTMLDisplay Deprecated.
protected Properties	formData Deprecated.
private String	headerSelector Deprecated.
private Locale	locale Deprecated.
private String	mode Deprecated.
private OutputStream	outputStream Deprecated.
private static String	RESOURCE Deprecated.
private boolean	showDirect Deprecated.
private HTMLTableColumnModel	tableColumnModel Deprecated.
protected String	tableContext Deprecated.
static String	TABLECONTEXT Deprecated.
private TableModel	tableModel Deprecated.
private static boolean	VERBOSE Deprecated.

Fields inherited from class wt.templateutil.components.HTMLTableComponent

ALIGN, BGCOLOR, BORDER, CELLPADDING, CELLSPACING, HEIGHT, HSPACE, TABLE_ALIGN, TABLE_BGCOLOR, TABLE_BORDER, TABLE_CELLPADDING, TABLE_CELLSPACING, TABLE_HEIGHT, TABLE_HSPACE, TABLE_VSPACE, TABLE_WIDTH, TAG, VSPACE, WIDTH

Fields inherited from class wt.templateutil.components.HTMLComponent

CLASS, COMPONENT_ID, COMPONENT_ID_SEPARATOR, CREATE, DEFAULT_SERVICE_NAME, DEFAULTS_ONLY, EMPTY_STRING, ID, ID_US_ENGLISH_LOCALE, NAME, NULLVALUE, PRINT_TAG_ATTR, SERVICENAME, UPDATE, VIEW

Constructor Summary

HTMLTable()
Deprecated.

HTMLTable(int numRows, int numColumns)
Deprecated.

HTMLTable(TableModel tableModel)
Deprecated.

HTMLTable(TableModel tableModel, HTMLTableColumnModel htmlTableColumnModel)
Deprecated.

HTMLTable(Vector rowData, Vector columnNames, Locale locale)
Deprecated.

Method Summary

String	add2Table(String currentTableStr, String additionalStr) Deprecated.
void	addColumn(HTMLTableColumn newColumn) Deprecated.
void	addNewColumn() Deprecated.
void	createDefaultColumnsFromModel() Deprecated.
HTMLComponent	getCellComponent(int rowNumber, int column, Properties props) Deprecated.
String	getCellSelector() Deprecated.
HTMLTableColumn	getColumn(int index) Deprecated.
HTMLTableColumn	getColumn(Object identifier) Deprecated.
Class	getColumnClass(int columnIndex) Deprecated.
int	getColumnCount() Deprecated.
int	getColumnIndex(Object columnIdentifier) Deprecated.
String	getColumnName(int columnIndex) Deprecated.
Enumeration	getColumns() Deprecated.
HTMLComponentFactory	getComponentFactory() Deprecated.
Properties	getFormData() Deprecated.
String	getHeaderSelector() Deprecated.
Locale	getLocale() Deprecated.
String	getMode() Deprecated.
OutputStream	getOutputStream() Deprecated.
int	getRowCount() Deprecated.
String	getTableCellID() Deprecated.
HTMLTableColumnModel	getTableColumnModel() Deprecated.
String	getTableContext() Deprecated.
String	getTableHeaderCellID() Deprecated.
TableModel	getTableModel() Deprecated.
protected String	getUniqueTableCellTrailId(int row, int col) Deprecated.
Object	getValueAt(int rowIndex, int columnIndex) Deprecated.
boolean	isDisplayHeader() Deprecated.
boolean	isShowDirect() Deprecated.
void	moveColumn(int oldIndex, int newIndex) Deprecated.
String	printHeaders(Object value, Properties formData, OutputStream os, Locale locale) Deprecated.
String	printRow(int rowNumber, Object value, Properties formData) Deprecated.
void	removeColumn(int index) Deprecated.
void	setCellSelector(String a_CellSelector) Deprecated.
void	setComponentFactory(HTMLComponentFactory a_ComponentFactory) Deprecated.
void	setDisplayHeader(boolean a_DisplayHeader) Deprecated.
void	setFormData(Properties newFormData) Deprecated.
void	setHeaderSelector(String a_HeaderSelector) Deprecated.
void	setLocale(Locale a_Locale) Deprecated.
void	setMode(String a_Mode) Deprecated.
void	setOutputStream(OutputStream a_OutputStream) Deprecated.
void	setShowDirect(boolean a_ShowDirect) Deprecated.
void	setTableColumnModel(HTMLTableColumnModel a_TableColumnModel) Deprecated.
void	setTableContext(String newTableContext) Deprecated.
void	setTableModel(TableModel a_TableModel) Deprecated.
String	show(Object value, Properties formData, OutputStream os, Locale locale) Deprecated.
void	show(Properties formData) Deprecated.
String	showSubComponents(Object value, Properties formData, OutputStream os, Locale locale) Deprecated. Returns a string that is the contcatenation of the result of calling show() on all the associated subComponents sequentially.

Methods inherited from class wt.templateutil.components.HTMLTableComponent

getTag, init, setTagListArray

Methods inherited from class wt.templateutil.components.HTMLComponent

appendID, appendID, appendToID, appendToID, createIDForComponent, endComponent, getHtmlComponents, getID, getIdProp, getName, getOID, getPrintWriter, getRealValue, getServiceName, getState, getTagID, getTagIDKey, getTagList, getTagSettings, getURLFactory, insertID, insertID, isInheritStyle, isPrintTagAttributes, isUseDefaultsOnly, main, putTagID, putTagID, removeID, removeTagID, setHtmlComponents, setID, setInheritStyle, setName, setPrintTagAttributes, setServiceName, setState, 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

Field Detail

RESOURCE

private static final String RESOURCE

Deprecated.

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Deprecated.

outputStream

private OutputStream outputStream

Deprecated.

VERBOSE

private static boolean VERBOSE

Deprecated.

locale

private Locale locale

Deprecated.

mode

private String mode

Deprecated.

cellSelector

private String cellSelector

Deprecated.

headerSelector

private String headerSelector

Deprecated.

showDirect

private boolean showDirect

Deprecated.

displayHeader

private boolean displayHeader

Deprecated.

tableModel

private TableModel tableModel

Deprecated.

tableColumnModel

private HTMLTableColumnModel tableColumnModel

Deprecated.

componentFactory

private HTMLComponentFactory componentFactory

Deprecated.

encodeValuesForHTMLDisplay

private static boolean encodeValuesForHTMLDisplay

Deprecated.

formData

protected Properties formData

Deprecated.

tableContext

protected String tableContext

Deprecated.

TABLECONTEXT

public static final String TABLECONTEXT

Deprecated.

See Also:

Constant Field Values

DEFAULT_TABLE_CELL_ID_VALUE

protected static final String DEFAULT_TABLE_CELL_ID_VALUE

Deprecated.

See Also:

Constant Field Values

Constructor Detail

HTMLTable

public HTMLTable(int numRows,
                 int numColumns)

Deprecated.

Supported API: true

Parameters:

numRows -

numColumns -

HTMLTable

public HTMLTable(TableModel tableModel)

Deprecated.

Supported API: true

Parameters:

tableModel -

HTMLTable

public HTMLTable(TableModel tableModel,
                 HTMLTableColumnModel htmlTableColumnModel)

Deprecated.

Supported API: true

Parameters:

tableModel -

htmlTableColumnModel -

HTMLTable

public HTMLTable(Vector rowData,
                 Vector columnNames,
                 Locale locale)

Deprecated.

Supported API: true

Parameters:

rowData -

columnNames -

locale -

HTMLTable

public HTMLTable()

Deprecated.

Method Detail

getOutputStream

public OutputStream getOutputStream()

Deprecated.

Gets the value of the attribute: outputStream.

Supported API: true

Returns:

OutputStream

setOutputStream

public void setOutputStream(OutputStream a_OutputStream)

Deprecated.

Sets the value of the attribute: outputStream.

Supported API: true

Parameters:

a_OutputStream -

getLocale

public Locale getLocale()

Deprecated.

Gets the value of the attribute: locale.

Supported API: true

Returns:

Locale

setLocale

public void setLocale(Locale a_Locale)

Deprecated.

Sets the value of the attribute: locale.

Supported API: true

Parameters:

a_Locale -

getMode

public String getMode()

Deprecated.

Gets the value of the attribute: mode.

Supported API: true

Returns:

String

setMode

public void setMode(String a_Mode)

Deprecated.

Sets the value of the attribute: mode.

Supported API: true

Parameters:

a_Mode -

getCellSelector

public String getCellSelector()

Deprecated.

Gets the value of the attribute: cellSelector.

Supported API: true

Returns:

String

setCellSelector

public void setCellSelector(String a_CellSelector)

Deprecated.

Sets the value of the attribute: cellSelector.

Supported API: true

Parameters:

a_CellSelector -

getHeaderSelector

public String getHeaderSelector()

Deprecated.

Gets the value of the attribute: headerSelector.

Supported API: true

Returns:

String

setHeaderSelector

public void setHeaderSelector(String a_HeaderSelector)

Deprecated.

Sets the value of the attribute: headerSelector.

Supported API: true

Parameters:

a_HeaderSelector -

isShowDirect

public boolean isShowDirect()

Deprecated.

Gets the value of the attribute: showDirect.

Supported API: true

Returns:

boolean

setShowDirect

public void setShowDirect(boolean a_ShowDirect)

Deprecated.

Sets the value of the attribute: showDirect.

Supported API: true

Parameters:

a_ShowDirect -

isDisplayHeader

public boolean isDisplayHeader()

Deprecated.

Gets the value of the attribute: displayHeader.

Supported API: true

Returns:

boolean

setDisplayHeader

public void setDisplayHeader(boolean a_DisplayHeader)

Deprecated.

Sets the value of the attribute: displayHeader.

Supported API: true

Parameters:

a_DisplayHeader -

getTableModel

public TableModel getTableModel()

Deprecated.

Gets the object for the association that plays role: tableModel.

Supported API: false

Returns:

TableModel

setTableModel

public void setTableModel(TableModel a_TableModel)

Deprecated.

Sets the object for the association that plays role: tableModel.

Supported API: true

Parameters:

a_TableModel -

getTableColumnModel

public HTMLTableColumnModel getTableColumnModel()

Deprecated.

Gets the object for the association that plays role: tableColumnModel.

Supported API: false

Returns:

HTMLTableColumnModel

setTableColumnModel

public void setTableColumnModel(HTMLTableColumnModel a_TableColumnModel)

Deprecated.

Sets the object for the association that plays role: tableColumnModel.

Supported API: true

Parameters:

a_TableColumnModel -

getComponentFactory

public HTMLComponentFactory getComponentFactory()

Deprecated.

Gets the object for the association that plays role: componentFactory.

Supported API: false

Returns:

HTMLComponentFactory

setComponentFactory

public void setComponentFactory(HTMLComponentFactory a_ComponentFactory)

Deprecated.

Sets the object for the association that plays role: componentFactory.

Supported API: false

Parameters:

a_ComponentFactory -

getColumnClass

public Class getColumnClass(int columnIndex)

Deprecated.

Returns the column class in the table model at the specified index.

Supported API: true

Parameters:

columnIndex -

Returns:

Class

getColumnName

public String getColumnName(int columnIndex)

Deprecated.

Gets the name of the column in the table model at the specified index.

Supported API: true

Parameters:

columnIndex -

Returns:

String

getRowCount

public int getRowCount()

Deprecated.

Returns the number of rows of data contained in the table model.

Supported API: true

Returns:

int

getValueAt

public Object getValueAt(int rowIndex,
                         int columnIndex)

Deprecated.

Returns the object contained in the table model in the location indicated by the row index and column index provided.

Supported API: true

Parameters:

rowIndex -

columnIndex -

Returns:

Object

printRow

public String printRow(int rowNumber,
                       Object value,
                       Properties formData)

Deprecated.

Returns a string that represents one table row of data. Including the opening and closing tags and the table cell tags. The data in any given cell is encoded for display in the HTML UI.

Supported API: true

Parameters:

rowNumber -

value -

formData -

Returns:

String

show

public void show(Properties formData)

Deprecated.

Sets the table's form data to the form data passed in and then calls showSubComponents to display the table.

Supported API: true

Parameters:

formData -

addNewColumn

public void addNewColumn()

Deprecated.

This method does nothing.

Supported API: true

printHeaders

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

Deprecated.

Returns a string that contains a table row with table data for each of the column headers. Unique ids are rendered for the coumn headers that require them.

Supported API: true

Parameters:

value -

formData -

os -

locale -

Returns:

String

addColumn

public void addColumn(HTMLTableColumn newColumn)

Deprecated.

Adds a column to the HTMLTableModel.

Supported API: true

Specified by:

addColumn in interface HTMLTableColumnModel

Parameters:

newColumn -

getColumn

public HTMLTableColumn getColumn(int index)

Deprecated.

Get the HTMLTableColumn object at column position index.

Supported API: true

Specified by:

getColumn in interface HTMLTableColumnModel

Parameters:

index -

Returns:

HTMLTableColumn

getColumn

public HTMLTableColumn getColumn(Object identifier)

Deprecated.

Get the HTMLTableColumn object with an identifier equal to the parameter identifier.

Supported API: true

Specified by:

getColumn in interface HTMLTableColumnModel

Parameters:

identifier -

Returns:

HTMLTableColumn

getColumnCount

public int getColumnCount()

Deprecated.

Returns the current number of columns set to be displayed by the HTMLTable

Supported API: true

Specified by:

getColumnCount in interface HTMLTableColumnModel

Returns:

int

moveColumn

public void moveColumn(int oldIndex,
                       int newIndex)

Deprecated.

Move the column with the display position of oldIndex to the display position of newIndex. The action taken on the column at newIndex is up to the implementation.

Supported API: true

Specified by:

moveColumn in interface HTMLTableColumnModel

Parameters:

oldIndex -

newIndex -

removeColumn

public void removeColumn(int index)

Deprecated.

Remove the column at display position index from the HTMLTableColumnModel. All of the columns behind the deleted column are moved forwards one position.

Supported API: true

Specified by:

removeColumn in interface HTMLTableColumnModel

Parameters:

index -

getColumnIndex

public int getColumnIndex(Object columnIdentifier)

Deprecated.

Returns the index of the column in the TableModel that corresponds to the column in the HTMLTableColumnModel with the identifier equal to columnIdentifier.

Supported API: true

Specified by:

getColumnIndex in interface HTMLTableColumnModel

Parameters:

columnIdentifier -

Returns:

int

getColumns

public Enumeration getColumns()

Deprecated.

Returns an enumeration of the HTMLTableColumns to be displayed by the HTMLTable.

Supported API: true

Specified by:

getColumns in interface HTMLTableColumnModel

Returns:

Enumeration

createDefaultColumnsFromModel

public void createDefaultColumnsFromModel()

Deprecated.

Goes through the Table Model and creates a default column for each column model in the table model.

Supported API: true

showSubComponents

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

Deprecated.

Description copied from class: HTMLComponent

Returns a string that is the contcatenation of the result of calling show() on all the associated subComponents sequentially.

Supported API: true

Overrides:

showSubComponents in class HTMLComponent

Parameters:

value -

formData -

os -

locale -

Returns:

String

getCellComponent

public HTMLComponent getCellComponent(int rowNumber,
                                      int column,
                                      Properties props)

Deprecated.

show

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

Deprecated.

Sets up the data models for the table, creates the columns, and then calls the super class show method.

Supported API: true

Overrides:

show in class HTMLComponent

Parameters:

value -

formData -

os -

locale -

Returns:

String

getFormData

public Properties getFormData()

Deprecated.

setFormData

public void setFormData(Properties newFormData)

Deprecated.

add2Table

public String add2Table(String currentTableStr,
                        String additionalStr)

Deprecated.

getTableContext

public String getTableContext()

Deprecated.

setTableContext

public void setTableContext(String newTableContext)

Deprecated.

getTableHeaderCellID

public String getTableHeaderCellID()

Deprecated.

getTableCellID

public String getTableCellID()

Deprecated.

getUniqueTableCellTrailId

protected String getUniqueTableCellTrailId(int row,
                                           int col)

Deprecated.