Package 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:
WTHtmlTable
public class HTMLTable extends HTMLTableComponent implements HTMLTableColumnModel
Deprecated.
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

  • Constructor Details

    • 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 -

  • Method Details

    • 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 -

    • setTableModel

      public void setTableModel(TableModel a_TableModel)
      Deprecated.
      Sets the object for the association that plays role: tableModel.

      Supported API: true
      Parameters:
      a_TableModel -

    • setTableColumnModel

      public void setTableColumnModel(HTMLTableColumnModel a_TableColumnModel)
      Deprecated.
      Sets the object for the association that plays role: tableColumnModel.

      Supported API: true
      Parameters:
      a_TableColumnModel -

    • 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

    • 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

    • 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
      Returns:
      String