wt.templateutil.table
Class CheckBoxTableColumn

java.lang.Object
  wt.templateutil.table.HTMLTableColumn
      wt.templateutil.table.CheckBoxTableColumn

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PDMLinkCheckboxColumn

public class CheckBoxTableColumn

extends HTMLTableColumn

implements Serializable

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.

The CheckBoxTableColumn is an extension of the HTMLTableColumn that is used by the WTHtmlTable to represent a column that is a column of HTML check boxes.

The HTML for the check boxes is generated by the CheckBoxCellComponent. See the CheckBoxCellComponent for the format of the output. This output will have to be interpreted by the FormTaskDelegate at the server that is processing the HTTP POST.

The contructors of the CheckBoxTableColumn set the cellComponent attribute to have an instance of a CheckBoxCellComponent so that when the cells in the column represented by the CheckBoxTableColumn rendered, a check box is genenereted.

The setHeader method is overriden to always return null. This will result in the column header always being set by the getColumnName method of the TableModel being used by the HTMLTable.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME Deprecated.
private static String	RESOURCE Deprecated.

Fields inherited from class wt.templateutil.table.HTMLTableColumn

Constructor Summary

CheckBoxTableColumn()
Deprecated. The no-arg constructor is overriden to have the cellComponent attribute set equal to an instance of a CheckBoxCellComponent.

CheckBoxTableColumn(int tableModelIndex)
Deprecated. The 1 argument constructor is overriden to have the cellComponent attribute set equal to an instance of a CheckBoxCellComponent after calling super.

Method Summary

Object

getHeader() Deprecated. Overriden to always return null.

Methods inherited from class wt.templateutil.table.HTMLTableColumn

getCellComponent, getColumnProperties, getHeaderComponent, getHeaderProperties, getIdentifier, getModelIndex, setCellComponent, setColumnProperties, setHeader, setHeaderComponent, setHeaderProperties, setIdentifier, setModelIndex

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.

Constructor Detail

CheckBoxTableColumn

public CheckBoxTableColumn()

Deprecated.

The no-arg constructor is overriden to have the cellComponent attribute set equal to an instance of a CheckBoxCellComponent.

CheckBoxTableColumn

public CheckBoxTableColumn(int tableModelIndex)

Deprecated.

The 1 argument constructor is overriden to have the cellComponent attribute set equal to an instance of a CheckBoxCellComponent after calling super.

Parameters:

tableModelIndex -

Method Detail

getHeader

public Object getHeader()

Deprecated.

Overriden to always return null. The assures the fact that unless the TableModel method, getColumnName will be used to define the Header presented on the table.

To present localized text in the Header of a column that is being presented by a CheckBoxTableColumn, the TableModel being used by the HTMLTable needs to return the desired localized text from the getColumnName method.

If the TableModel being used implements the TableHeaderSetter interface, then this can be done with a call directly on the setHeaderFromResource method or through the HTML Table service windchill script call, setHeaderFromResource.

Overrides:

getHeader in class HTMLTableColumn

Returns:

Object