wt.templateutil.table
Class WTHtmlTable

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

All Implemented Interfaces:

CheckBoxColumnAble, HTMLTableColumnModel

Direct Known Subclasses:

ChangeableAssociationTable, DocumentReferenceTable, PDMLinkHTMLTable, SubjectProductAssociationTable

public class WTHtmlTable

extends HTMLTable

implements CheckBoxColumnAble

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 HTMLTable that adds the addition functionality of being able to add/display a checkbox column based on the value of the presentCheckBox field. If the presentCheckBox field is false (the default), then the WTHtmlTable functions essentially the same as the HTMLTable. However, if the presentCheckBox is set to true then the first column in the table will present a checkbox in every row (via CheckBoxTableColumn) and the corresponding TableModel used by the WTHtmlTable will be updated with the new column. The handle for the new column in the TableModel will be the current value of the field, checkBoxName. The default value for this field is CheckBoxColumnAble.CHECK_BOX_COLUMN_NAME. This value can be set using the setCheckBoxName method(do this before calling the createDefaultColumnsFromModel method). If the AssociationTableModel is being used as the TableModel, the checkbox column will be associated with the OtherSide class.

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

Supported API: true

Extendable: false

Field Summary

private String	checkBoxName Deprecated.
private static String	CLASSNAME Deprecated.
private boolean	presentCheckBox Deprecated.
private static String	RESOURCE Deprecated.
private boolean	showPendingIcon Deprecated.
private boolean	suppressIcon Deprecated.
private boolean	suppressLink Deprecated.
private static boolean	VERBOSE Deprecated.

Fields inherited from class wt.templateutil.table.HTMLTable

DEFAULT_TABLE_CELL_ID_VALUE, formData, tableContext, TABLECONTEXT

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

Fields inherited from interface wt.templateutil.table.CheckBoxColumnAble

CHECK_BOX_COLUMN_NAME, PRESENT_CHECK_BOX

Constructor Summary

WTHtmlTable()
Deprecated.

Method Summary

void	addColumn() Deprecated.
void	createDefaultColumnsFromModel() Deprecated.
String	getCheckBoxName() Deprecated. Gets the name/handle of the checkbox column in the TableModel Supported API: false
boolean	isPendingIcon() Deprecated.
boolean	isPresentCheckBox() Deprecated. Gets the flag indicating whether to present a checkbox at the front of the table.
boolean	isSuppressIcon() Deprecated.
boolean	isSuppressLink() Deprecated.
protected CheckBoxTableColumn	newCheckBoxTableColumn(int tableModelIndex) Deprecated.
void	setCheckBoxName(String a_CheckBoxName) Deprecated. Sets the name/handle of the checkbox column in the TableModel Supported API: false
void	setPendingIcon(boolean pendingIcon) Deprecated.
void	setPresentCheckBox(boolean a_PresentCheckBox) Deprecated. Sets the flag indicating whether to present a checkbox at the front of the table.
void	setSuppressIcon(boolean suppressIcon) Deprecated.
void	setSuppressLink(boolean suppressLink) Deprecated.

Methods inherited from class wt.templateutil.table.HTMLTable

add2Table, addColumn, addNewColumn, getCellComponent, getCellSelector, getColumn, getColumn, getColumnClass, getColumnCount, getColumnIndex, getColumnName, getColumns, getComponentFactory, getFormData, getHeaderSelector, getLocale, getMode, getOutputStream, getRowCount, getTableCellID, getTableColumnModel, getTableContext, getTableHeaderCellID, getTableModel, getUniqueTableCellTrailId, getValueAt, isDisplayHeader, isShowDirect, moveColumn, printHeaders, printRow, removeColumn, setCellSelector, setComponentFactory, setDisplayHeader, setFormData, setHeaderSelector, setLocale, setMode, setOutputStream, setShowDirect, setTableColumnModel, setTableContext, setTableModel, show, show, showSubComponents

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.

checkBoxName

private String checkBoxName

Deprecated.

presentCheckBox

private boolean presentCheckBox

Deprecated.

VERBOSE

private static boolean VERBOSE

Deprecated.

suppressIcon

private boolean suppressIcon

Deprecated.

suppressLink

private boolean suppressLink

Deprecated.

showPendingIcon

private boolean showPendingIcon

Deprecated.

Constructor Detail

WTHtmlTable

public WTHtmlTable()

Deprecated.

Method Detail

getCheckBoxName

public String getCheckBoxName()

Deprecated.

Gets the name/handle of the checkbox column in the TableModel

Supported API: false

Returns:

String

setCheckBoxName

public void setCheckBoxName(String a_CheckBoxName)

Deprecated.

Sets the name/handle of the checkbox column in the TableModel

Supported API: false

Parameters:

a_CheckBoxName -

createDefaultColumnsFromModel

public void createDefaultColumnsFromModel()

Deprecated.

Initializes the DefaultHTMLTableColumnModel based on the current TableModel. If presentCheckBox=true, then the first column in the DefaultHTMLTableColumnModel will be an instance of the CheckBoxTableColumn and the TableModel will be updated by adding a new column to it to represent the new checkbox column.

Supported API: true

Overrides:

createDefaultColumnsFromModel in class HTMLTable

newCheckBoxTableColumn

protected CheckBoxTableColumn newCheckBoxTableColumn(int tableModelIndex)

Deprecated.

Returns a new instance of CheckBoxTableColumn, configured for use in this table.

Supported API: true

Parameters:

tableModelIndex -

Returns:

CheckBoxTableColumn

isPresentCheckBox

public boolean isPresentCheckBox()

Deprecated.

Gets the flag indicating whether to present a checkbox at the front of the table.

Supported API: true

Specified by:

isPresentCheckBox in interface CheckBoxColumnAble

Returns:

boolean

setPresentCheckBox

public void setPresentCheckBox(boolean a_PresentCheckBox)

Deprecated.

Sets the flag indicating whether to present a checkbox at the front of the table.

Supported API: true

Specified by:

setPresentCheckBox in interface CheckBoxColumnAble

Parameters:

a_PresentCheckBox -

addColumn

public void addColumn()

Deprecated.

setSuppressIcon

public void setSuppressIcon(boolean suppressIcon)

Deprecated.

isSuppressIcon

public boolean isSuppressIcon()

Deprecated.

setSuppressLink

public void setSuppressLink(boolean suppressLink)

Deprecated.

isSuppressLink

public boolean isSuppressLink()

Deprecated.

setPendingIcon

public void setPendingIcon(boolean pendingIcon)

Deprecated.

isPendingIcon

public boolean isPendingIcon()

Deprecated.