Package wt.templateutil.table

Class HTMLTableColumn

java.lang.Object
wt.templateutil.table.HTMLTableColumn
Direct Known Subclasses:
ActionsTableColumn, CheckBoxTableColumn, IconTableColumn, LatestVersionTableColumn, TreeTableColumn
public class HTMLTableColumn extends Object
Deprecated.
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 the base class for objects that represent a Column in an HTMLTable. Any object that wants to represent an Column in an HTMLTable must subclass this class.

This is a simple, default implementation of a column object. It is essentially a place holder for information to be used when generating the header and the cells for a column in an HTMLTable. Subclasses can add some business logic, presentation logic, or specialized defaults to be used when rendering the header and cells in a column.

Supported API: true

Extendable: false

  • Constructor Summary

    Constructors
    Constructor
    Description
    HTMLTableColumn(int modelIndex)
    Deprecated. 

  • Method Summary

    Modifier and Type
    Method
    Description
    Properties
    getColumnProperties()
    Deprecated.
    Gets the Properties object that is passed off to each HTML Components used to render a cell in this column.
    Object
    getHeader()
    Deprecated.
    Gets the object that represents the value to present in the Header of of the column

    Supported API: true
    HTMLComponent
    getHeaderComponent()
    Deprecated.
    Gets the HTML component preferred by the column to present the header.
    Properties
    getHeaderProperties()
    Deprecated.
    Gets the Properties object that is passed off to the HTML Component used to render a header in this column.
    Object
    getIdentifier()
    Deprecated.
    Gets the identifier of the column that will be used to reference the column during Windchill script calls with the HTML Table Service.
    int
    getModelIndex()
    Deprecated.
    Gets the column index of the column in the TableModel that this column is visually representing

    Supported API: true
    void
    setColumnProperties(Properties a_ColumnProperties)
    Deprecated.
    Sets the Properties object that is passed off to each HTML Components used to render a cell in this column.
    void
    setHeader(Object a_Header)
    Deprecated.
    Sets the object that represents the value to present in the Header of of the column

    Supported API: true
    void
    setHeaderProperties(Properties a_HeaderProperties)
    Deprecated.
    Sets the Properties object that is passed off to the HTML Component used to render a header in this column.
    void
    setIdentifier(Object a_Identifier)
    Deprecated.
    Sets the identifier of the column that will be used to reference the column during Windchill script calls with the HTML Table Service.
    void
    setModelIndex(int a_ModelIndex)
    Deprecated.
    Sets the column index of the column in the TableModel that this column is visually representing

    Supported API: true

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • HTMLTableColumn

      public HTMLTableColumn(int modelIndex)
      Deprecated.
      Constuctor that sets the modelIndex of the column that points to the corresponding column in the TableModel.

      Supported API: true
      Parameters:
      modelIndex -

  • Method Details

    • getHeader

      public Object getHeader()
      Deprecated.
      Gets the object that represents the value to present in the Header of of the column

      Supported API: true
      Returns:
      Object

    • setHeader

      public void setHeader(Object a_Header)
      Deprecated.
      Sets the object that represents the value to present in the Header of of the column

      Supported API: true
      Parameters:
      a_Header -

    • getIdentifier

      public Object getIdentifier()
      Deprecated.
      Gets the identifier of the column that will be used to reference the column during Windchill script calls with the HTML Table Service.

      If the TableModel being used implements the ColumnIdentifier interface, the value for the identifier will be set during the addMethod call when the column is added to the HTMLTableColumnModel

      Supported API: true

      Returns:
      Object

    • setIdentifier

      public void setIdentifier(Object a_Identifier)
      Deprecated.
      Sets the identifier of the column that will be used to reference the column during Windchill script calls with the HTML Table Service.

      If the TableModel being used implements the ColumnIdentifier interface, the value for the identifier will be set during the addMethod call when the column is added to the HTMLTableColumnModel

      Supported API: true

      Parameters:
      a_Identifier -

    • getModelIndex

      public int getModelIndex()
      Deprecated.
      Gets the column index of the column in the TableModel that this column is visually representing

      Supported API: true
      Returns:
      int

    • setModelIndex

      public void setModelIndex(int a_ModelIndex)
      Deprecated.
      Sets the column index of the column in the TableModel that this column is visually representing

      Supported API: true
      Parameters:
      a_ModelIndex -

    • getColumnProperties

      public Properties getColumnProperties()
      Deprecated.
      Gets the Properties object that is passed off to each HTML Components used to render a cell in this column.

      This Properties object is passed into the HTML component in the init method of the HTML component when the HTMLTable is rendering the cell.

      Supported API: true

      Returns:
      Properties

    • setColumnProperties

      public void setColumnProperties(Properties a_ColumnProperties)
      Deprecated.
      Sets the Properties object that is passed off to each HTML Components used to render a cell in this column.

      This Properties object is passed into the HTML component in the init method of the HTML component when the HTMLTable is rendering the cell.

      Supported API: true

      Parameters:
      a_ColumnProperties -

    • getHeaderProperties

      public Properties getHeaderProperties()
      Deprecated.
      Gets the Properties object that is passed off to the HTML Component used to render a header in this column.

      This Properties object is passed into the HTML component in the init method of the HTML component when the HTMLTable is rendering the header.

      Supported API: true

      Returns:
      Properties

    • setHeaderProperties

      public void setHeaderProperties(Properties a_HeaderProperties)
      Deprecated.
      Sets the Properties object that is passed off to the HTML Component used to render a header in this column.

      This Properties object is passed into the HTML component in the init method of the HTML component when the HTMLTable is rendering the header.

      Supported API: true

      Parameters:
      a_HeaderProperties -

    • getHeaderComponent

      public HTMLComponent getHeaderComponent()
      Deprecated.
      Gets the HTML component preferred by the column to present the header.

      By default this value is null. If it is set, then the HTMLTable will use this component instead of going to the HTMLComponentFactory to select the appropriate HTML component.

      Supported API: true

      Returns:
      HTMLComponent