wt.templateutil.table
Class PDMLinkHTMLTable

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

All Implemented Interfaces:

CheckBoxColumnAble, HTMLTableColumnModel

Direct Known Subclasses:

PickerHTMLTable

public class PDMLinkHTMLTable

extends WTHtmlTable

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 WTHtmlTable that provides the following changes/modifications in addition the existing features of WTHtmlTable

• Uses components specific to the PDMLink (Header, column, and cell)
• Provides "Action Row" at the top of the table with configurable "Multiselect" and "Context Object" links
• Provides sorting of the table based on the order (both increasing and decreasing) of a selected column
• Provides the ability to hide (collapse) one or more columns
• A localized message to be presented in the Table body if there are not any rows to display

In addition, all of the existing TableService script calls can be used with/applied to PDMLinkHTMLTable instances.

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

Supported API: true

Extendable: false

Field Summary

protected static String	ACTION_LINK_END Deprecated.
protected static String	ACTION_LINK_MIDDLE Deprecated.
protected static String	ACTION_LINK_START Deprecated.
protected static String	ACTION_ROW Deprecated.
private static String	ACTIONLINK_TEMPLATE Deprecated.
private List	actionList Deprecated.
private String	actionNavBarName Deprecated.
private String	actionNavBarStyleClass Deprecated.
protected static String	ALIGN Deprecated.
protected static String	BOLD Deprecated.
private String	checkBoxName Deprecated.
protected static String	CLASS Deprecated.
private static String	CLASSNAME Deprecated.
protected static String	COLUMN_NAME Deprecated.
static String	DEFAULT_ACTION_BAR_STYLE_CLASS Deprecated.
protected static String	EDIT_BAR Deprecated.
protected static String	ELEMENT_END Deprecated.
protected static String	ELEMENT_END_W_QUOTE Deprecated.
protected static String	EMPTY_STRING Deprecated.
private static boolean	encodeValuesForHTMLDisplay Deprecated.
private static String	END_TEMPLATE Deprecated.
protected static String	FILLER_NODE_END Deprecated.
protected static String	FILLER_NODE_START Deprecated.
private String	formName Deprecated.
protected static String	IMG Deprecated.
protected static String	IS_EMPTY Deprecated.
private boolean	isCollapsingEnabled Deprecated.
private boolean	isSortingEnabled Deprecated.
protected static String	LOCALE Deprecated.
static String	MULTISELECT_ACTIONS_BAR_STYLE_CLASS Deprecated.
private List	multiSelectActionList Deprecated.
private String	multiSelectActionNavBarName Deprecated.
static String	NO_RESULTS_MESSAGE_ALIGNMENT Deprecated.
static Class	PDM_DEFAULT_TABLE_CLASS Deprecated.
static String	PDM_LINK_HTML_TABLE Deprecated.
private boolean	presentActionsIconColumn Deprecated.
private boolean	presentCheckBox Deprecated.
private boolean	presentIconFirstColumn Deprecated.
private boolean	presentIconFirstNoLinkColumn Deprecated.
protected static String	ROW_END Deprecated.
protected static String	START_ROW Deprecated.
private int	tableWidth Deprecated.
private static String	TARGET_TEMPLATE_PROCESSOR Deprecated.
private static String[]	TD_CLASS_ARRAY Deprecated.
protected static String	TR_BEGIN Deprecated.
protected static String	TR_END Deprecated.
protected static String	TRUE Deprecated.
protected static String	TWO Deprecated.
private static boolean	VERBOSE Deprecated.

Fields inherited from class wt.templateutil.table.WTHtmlTable

Fields inherited from class wt.templateutil.table.HTMLTable

DEFAULT_TABLE_CELL_ID_VALUE, formData, tableContext, TABLECONTEXT

Fields inherited from class wt.templateutil.components.HTMLTableComponent

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

COMPONENT_ID, COMPONENT_ID_SEPARATOR, CREATE, DEFAULT_SERVICE_NAME, DEFAULTS_ONLY, 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

PDMLinkHTMLTable()
Deprecated.

Method Summary

protected HTMLTemplate	actionLinkTemplate() Deprecated. This method is not currently used and is not going to be used.
void	addColumn() Deprecated. If the current TableModel is implements the AddColumn interface, then a PDMLinkCheckboxColumn is added to the current TableColumnModel and the TableModel is updated accordingly.
void	createDefaultColumnsFromModel() Deprecated.
List	getActionList() Deprecated. Returns the list that represents the subset of links in the actionNavBarName section of the Navigation Configuration XML file to be used to generate the "Context Object Action" section of the Action Row.
String	getActionNavBarName() Deprecated. Returns the name of the ection in the Navigation Configuration XML file that should be used to generate the "Context Object Action" section of the Action Bar.
String	getActionNavBarStyleClass() Deprecated. Returns the name of stylesheet class to be used for background color of action icons
protected String	getActionRow(Object value, Properties formData, OutputStream os, Locale locale) Deprecated. Generates the Action Row for the HTML Table.
String	getActionRowString(Properties parameters, Locale locale, OutputStream os, String serviceName, String navBarName, List navBarList) Deprecated. This method is not currently used and is not going to be used.
HTMLComponent	getCellComponent(int rowNumber, int column, Properties props) Deprecated. Retrieves an HTMLComponent with an ApplicationContextService factory call and initializes the HTMLComponent.
protected HTMLTemplate	getEndRowTemplate() Deprecated. This method is not currently used and is not going to be used.
String	getFormName() Deprecated.
protected HTMLTemplate	getHTMLTemplate(String templateFileName) Deprecated. This method is not currently used and is not going to be used.
List	getMultiSelectActionList() Deprecated. Returns the list that represents the subset of links in the multiSelectActionNavBarName section of the Navigation Configuration XML file to be used to generate the "Multi-select" section of the Action Row.
String	getMultiSelectActionNavBarName() Deprecated. Returns the name of the ection in the Navigation Configuration XML file that should be used to generate the "Multi-select" section of the Action Bar.
static PDMLinkHTMLTable	getPDMLinkHTMLTable() Deprecated. This method is not currently used and is not going to be used.
protected String	getRow(NavigationTreeModel treeModel, Properties parameters, Locale locale) Deprecated. This method is not currently used and is not going to be used.
TableModel	getTableModel() Deprecated. Retrieves the current TableModel that represent the data to be displayed.
int	getTableWidth() Deprecated.
protected DefaultTemplateProcessor	getTemplateProcessor() Deprecated. This method is not currently used and is not going to be used.
protected HTMLComponent	initCellComponent(HTMLComponent cellComponent, Object cellObject, int rowNumber, int column, Properties props) Deprecated.
boolean	isCollapsingEnabled() Deprecated. Returns the flag that determines if hiding(collapsing) is enabled on the columns of the HTML Table
boolean	isPresentActionsIconColumn() Deprecated. Returns the flag that indicates if the "Action Column" is to be presented.
boolean	isPresentIconFirstNoLinkRow() Deprecated.
boolean	isPresentIconFirstRow() Deprecated. Returns the flag that indicates if the "First Column" is to be presented.
boolean	isSortingEnabled() Deprecated. Returns the flag that determines if sorting is enabled on the columns of the HTML Table
protected PDMLinkCheckboxColumn	newPDMLinkCheckboxColumn(int currentNumberOfColumns) Deprecated.
String	printHeaders(Object value, Properties formData, OutputStream os, Locale locale) Deprecated. Generates the HTML for the column headers for the data rows.
String	printHeaders(PDMLinkCheckboxHeader checkBoxHeader, Object value, Properties formData, OutputStream os, Locale locale) Deprecated. Generates the HTML for the column headers for the data rows.
String	printNoResultsRow(Locale locale) Deprecated. Generates the HTML table body in the case when there are not any data rows to present.
String	printRow(int rowNumber, Object value, Properties formData) Deprecated. Displays a row of data in the body of the HTML Table.
void	setActionList(List actionList) Deprecated. Specifies which of the actions listed in the action section of the NavigationAndActions.xml file should be displayed in the context-specific action bar of the table.
void	setActionNavBarName(String actionNavBarName) Deprecated. Set the name of the section in the Navigation Configuration XML file that should be used to generate the "Context Object Action" section of the Action Bar
void	setActionNavBarStyleClass(String styleClass) Deprecated. Set the name of stylesheet class to be used for background color of action icons
void	setFormName(String formName) Deprecated.
void	setIsCollapsingEnabled(boolean isCollapsingEnabled) Deprecated.
void	setIsSortingEnabled(boolean isSortingEnabled) Deprecated.
void	setMultiSelectActionList(List multiSelectActionList) Deprecated. Specifies which of the actions listed in the multiselect action section of the NavigationAndActions.xml file should be displayed in the multiselect action bar of the table.
void	setMultiSelectActionNavBarName(String multiSelectActionNavBarName) Deprecated. Set the name of the section in the Navigation Configuration XML file that should be used to generate the "Multi-select" section of the Action Bar.
void	setPresentActionsIconColumn(boolean presentActionsIconColumn) Deprecated.
void	setPresentIconFirstNoLinkRow(boolean presentIconFirstNoLinkColumn) Deprecated.
void	setPresentIconFirstRow(boolean presentIconFirstColumn) Deprecated.
void	setTableWidth(int tableWidth) Deprecated.
String	showSubComponents(Object value, Properties formData, OutputStream os, Locale locale) Deprecated.

Methods inherited from class wt.templateutil.table.WTHtmlTable

getCheckBoxName, isPendingIcon, isPresentCheckBox, isSuppressIcon, isSuppressLink, newCheckBoxTableColumn, setCheckBoxName, setPendingIcon, setPresentCheckBox, setSuppressIcon, setSuppressLink

Methods inherited from class wt.templateutil.table.HTMLTable

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

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

CLASSNAME

private static final String CLASSNAME

Deprecated.

checkBoxName

private String checkBoxName

Deprecated.

presentCheckBox

private boolean presentCheckBox

Deprecated.

presentIconFirstColumn

private boolean presentIconFirstColumn

Deprecated.

presentIconFirstNoLinkColumn

private boolean presentIconFirstNoLinkColumn

Deprecated.

presentActionsIconColumn

private boolean presentActionsIconColumn

Deprecated.

tableWidth

private int tableWidth

Deprecated.

TD_CLASS_ARRAY

private static final String[] TD_CLASS_ARRAY

Deprecated.

VERBOSE

private static final boolean VERBOSE

Deprecated.

TARGET_TEMPLATE_PROCESSOR

private static final String TARGET_TEMPLATE_PROCESSOR

Deprecated.

END_TEMPLATE

private static final String END_TEMPLATE

Deprecated.

ACTIONLINK_TEMPLATE

private static final String ACTIONLINK_TEMPLATE

Deprecated.

multiSelectActionNavBarName

private String multiSelectActionNavBarName

Deprecated.

actionNavBarName

private String actionNavBarName

Deprecated.

actionNavBarStyleClass

private String actionNavBarStyleClass

Deprecated.

multiSelectActionList

private List multiSelectActionList

Deprecated.

actionList

private List actionList

Deprecated.

formName

private String formName

Deprecated.

MULTISELECT_ACTIONS_BAR_STYLE_CLASS

public static final String MULTISELECT_ACTIONS_BAR_STYLE_CLASS

Deprecated.

DEFAULT_ACTION_BAR_STYLE_CLASS

public static final String DEFAULT_ACTION_BAR_STYLE_CLASS

Deprecated.

See Also:

Constant Field Values

PDM_LINK_HTML_TABLE

public static final String PDM_LINK_HTML_TABLE

Deprecated.

PDM_DEFAULT_TABLE_CLASS

public static final Class PDM_DEFAULT_TABLE_CLASS

Deprecated.

NO_RESULTS_MESSAGE_ALIGNMENT

public static final String NO_RESULTS_MESSAGE_ALIGNMENT

Deprecated.

isSortingEnabled

private boolean isSortingEnabled

Deprecated.

isCollapsingEnabled

private boolean isCollapsingEnabled

Deprecated.

START_ROW

protected static final String START_ROW

Deprecated.

See Also:

Constant Field Values

ALIGN

protected static final String ALIGN

Deprecated.

See Also:

Constant Field Values

CLASS

protected static final String CLASS

Deprecated.

See Also:

Constant Field Values

ELEMENT_END

protected static final String ELEMENT_END

Deprecated.

See Also:

Constant Field Values

IMG

protected static final String IMG

Deprecated.

See Also:

Constant Field Values

ELEMENT_END_W_QUOTE

protected static final String ELEMENT_END_W_QUOTE

Deprecated.

See Also:

Constant Field Values

BOLD

protected static final String BOLD

Deprecated.

See Also:

Constant Field Values

ROW_END

protected static final String ROW_END

Deprecated.

See Also:

Constant Field Values

TR_BEGIN

protected static final String TR_BEGIN

Deprecated.

See Also:

Constant Field Values

TR_END

protected static final String TR_END

Deprecated.

See Also:

Constant Field Values

EDIT_BAR

protected static final String EDIT_BAR

Deprecated.

See Also:

Constant Field Values

TWO

protected static final String TWO

Deprecated.

See Also:

Constant Field Values

ACTION_ROW

protected static final String ACTION_ROW

Deprecated.

See Also:

Constant Field Values

IS_EMPTY

protected static final String IS_EMPTY

Deprecated.

See Also:

Constant Field Values

TRUE

protected static final String TRUE

Deprecated.

See Also:

Constant Field Values

COLUMN_NAME

protected static final String COLUMN_NAME

Deprecated.

See Also:

Constant Field Values

FILLER_NODE_START

protected static final String FILLER_NODE_START

Deprecated.

See Also:

Constant Field Values

FILLER_NODE_END

protected static final String FILLER_NODE_END

Deprecated.

See Also:

Constant Field Values

ACTION_LINK_START

protected static final String ACTION_LINK_START

Deprecated.

See Also:

Constant Field Values

ACTION_LINK_MIDDLE

protected static final String ACTION_LINK_MIDDLE

Deprecated.

See Also:

Constant Field Values

ACTION_LINK_END

protected static final String ACTION_LINK_END

Deprecated.

See Also:

Constant Field Values

LOCALE

protected static final String LOCALE

Deprecated.

See Also:

Constant Field Values

EMPTY_STRING

protected static final String EMPTY_STRING

Deprecated.

See Also:

Constant Field Values

encodeValuesForHTMLDisplay

private static boolean encodeValuesForHTMLDisplay

Deprecated.

Constructor Detail

PDMLinkHTMLTable

public PDMLinkHTMLTable()

Deprecated.

Method Detail

createDefaultColumnsFromModel

public void createDefaultColumnsFromModel()

Deprecated.

Initialize the TableColumnModel by instantiating TableColumn subclasses based on

• The Type of the TableModel (TreeTableModel or not)
• Position in the table of the column
• If the checkbox column is to be presented
• If the First column of data is presented

and then adding the TableColumn instances to the TableColumnModel.

By setting the isIconColumnFirst flag to true (default), the first column will be either a TreeTableColumn (if the TableModel is of Type TreeTableModel) or a PDMLinkIconTableColumn.

By setting the isPresentActionsIconColumn to true (default), an ActionsTableColumn column will be added either as the first column (isIconColumnFirst == false) or the second column

Supported API: true

Overrides:

createDefaultColumnsFromModel in class WTHtmlTable

addColumn

public void addColumn()

Deprecated.

If the current TableModel is implements the AddColumn interface, then a PDMLinkCheckboxColumn is added to the current TableColumnModel and the TableModel is updated accordingly.

Overrides:

addColumn in class WTHtmlTable

newPDMLinkCheckboxColumn

protected PDMLinkCheckboxColumn newPDMLinkCheckboxColumn(int currentNumberOfColumns)

Deprecated.

showSubComponents

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

Deprecated.

Method that actually generates the HTML Table by generating the sections of the HTML Table in the following order (if the section is to be generated).

• The Action Row
• The Table Column Headers
• The Rows in the Body of the HTML table

The generation of the Action Row depends if there is a Multi-Select section or a Context Action Section to be generated.

The display of the Table Column headers can be disabled by setting the isDisplayHeader flag to false.

In the case that there are not any rows to display in the body of the table, the "No Results" message will be presented in the body of the HTML Table.

Supported API: true

Overrides:

showSubComponents in class HTMLTable

Parameters:

value -

formData -

os -

Returns:

locale

getActionRow

protected String getActionRow(Object value,
                              Properties formData,
                              OutputStream os,
                              Locale locale)

Deprecated.

Generates the Action Row for the HTML Table. The Action Row includes

• The Checkbox Column Header (if the checkbox column is displayed)
• The Multiselection Action Links
• The Context Object Action Links

If the table is configured so that none of the three elements listed above are to be displayed, the empty String, "", is returned.

For the generation of the checkbox column header, the PDMLinkCheckboxHeader HTML Component is used.

Parameters:

value -

formData -

os -

Returns:

locale

getActionRowString

public String getActionRowString(Properties parameters,
                                 Locale locale,
                                 OutputStream os,
                                 String serviceName,
                                 String navBarName,
                                 List navBarList)

Deprecated. This method is not currently used and is not going to be used.

Parameters:

parameters -

locale -

os -

serviceName -

navBarName -

navBarList -

getRow

protected String getRow(NavigationTreeModel treeModel,
                        Properties parameters,
                        Locale locale)

Deprecated. This method is not currently used and is not going to be used.

Parameters:

treeModel -

parameters -

locale -

getEndRowTemplate

protected HTMLTemplate getEndRowTemplate()

Deprecated. This method is not currently used and is not going to be used.

actionLinkTemplate

protected HTMLTemplate actionLinkTemplate()

Deprecated. This method is not currently used and is not going to be used.

getHTMLTemplate

protected HTMLTemplate getHTMLTemplate(String templateFileName)

Deprecated. This method is not currently used and is not going to be used.

getTemplateProcessor

protected DefaultTemplateProcessor getTemplateProcessor()

Deprecated. This method is not currently used and is not going to be used.

setTableWidth

public void setTableWidth(int tableWidth)

Deprecated.

getTableWidth

public int getTableWidth()

Deprecated.

printHeaders

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

Deprecated.

Generates the HTML for the column headers for the data rows. These headers will sit beneath the Action Row, if the Action Row is displayed.

This method takes into account if the TableColumn instance used for a particular column if of type PDMLinkTableColumn. If so, the PDMLinkTableColumn will receive additional parameters for controlling the sorting and hiding(collapsing).

Overrides:

printHeaders in class HTMLTable

Parameters:

value -

formData -

os -

locale -

Returns:

locale

printHeaders

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

Deprecated.

Generates the HTML for the column headers for the data rows. These headers will sit beneath the Action Row, if the Action Row is displayed.

This method takes into account if the TableColumn instance used for a particular column if of type PDMLinkTableColumn. If so, the PDMLinkTableColumn will receive additional parameters for controlling the sorting and hiding(collapsing).

Parameters:

value -

formData -

os -

checkBoxHeader - - the All checkbox that will be used

Returns:

locale

printRow

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

Deprecated.

Displays a row of data in the body of the HTML Table. This method simply enumerates through the columns in the TableModel for the current row as specified by the rowNumber parameter.

Overrides:

printRow in class HTMLTable

Parameters:

rowNumber -

value -

formData -

Returns:

String

getCellComponent

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

Deprecated.

Retrieves an HTMLComponent with an ApplicationContextService factory call and initializes the HTMLComponent.

Overrides:

getCellComponent in class HTMLTable

Parameters:

rowNumber -

column -

props -

getMultiSelectActionNavBarName

public String getMultiSelectActionNavBarName()

Deprecated.

Returns the name of the ection in the Navigation Configuration XML file that should be used to generate the "Multi-select" section of the Action Bar.

setMultiSelectActionNavBarName

public void setMultiSelectActionNavBarName(String multiSelectActionNavBarName)

Deprecated.

Set the name of the section in the Navigation Configuration XML file that should be used to generate the "Multi-select" section of the Action Bar.

Parameters:

multiSelectActionNavBarName -

getActionNavBarStyleClass

public String getActionNavBarStyleClass()

Deprecated.

Returns the name of stylesheet class to be used for background color of action icons

setActionNavBarStyleClass

public void setActionNavBarStyleClass(String styleClass)

Deprecated.

Set the name of stylesheet class to be used for background color of action icons

getMultiSelectActionList

public List getMultiSelectActionList()

Deprecated.

Returns the list that represents the subset of links in the multiSelectActionNavBarName section of the Navigation Configuration XML file to be used to generate the "Multi-select" section of the Action Row.

If the List is null or empty, all of the links in the multiSelectActionNavBarName will be used. This is the default.

setMultiSelectActionList

public void setMultiSelectActionList(List multiSelectActionList)

Deprecated.

Specifies which of the actions listed in the multiselect action section of the NavigationAndActions.xml file should be displayed in the multiselect action bar of the table. At most nine actions can be displayed in the action bar.

Use the method setMultiSelectActionNavBarName() to specifiy the section in NavigationAndActions.xml to use for the multiselect action bar of this table.

If the List argument is null or empty, all of the links in the specified NavigationAndActions.xml section will be used. This is the default.

Parameters:

multiSelectActionList - - Subset of links in multiSelectActionNavBarName section

getActionNavBarName

public String getActionNavBarName()

Deprecated.

Returns the name of the ection in the Navigation Configuration XML file that should be used to generate the "Context Object Action" section of the Action Bar.

setActionNavBarName

public void setActionNavBarName(String actionNavBarName)

Deprecated.

Set the name of the section in the Navigation Configuration XML file that should be used to generate the "Context Object Action" section of the Action Bar

getActionList

public List getActionList()

Deprecated.

Returns the list that represents the subset of links in the actionNavBarName section of the Navigation Configuration XML file to be used to generate the "Context Object Action" section of the Action Row.

If the List is null or empty, all of the links in the actionNavBarName will be used. This is the default.

setActionList

public void setActionList(List actionList)

Deprecated.

Specifies which of the actions listed in the action section of the NavigationAndActions.xml file should be displayed in the context-specific action bar of the table. At most nine actions can be displayed in the action bar.

Use the method setActionNavBarName() to specifiy the section in NavigationAndActions.xml to use for the context-specific action bar of this table.

If the List argument is null or empty, all of the links in the specified NavigationAndActions.xml section will be used. This is the default.

Parameters:

actionList - - Subset of links in actionNavBarName section

getTableModel

public TableModel getTableModel()

Deprecated.

Retrieves the current TableModel that represent the data to be displayed. In the case that the current TableModel is an instance of SortedTableModel, the TableModel behind the SortedTableModel is returned.

Overrides:

getTableModel in class HTMLTable

Returns:

TableModel

printNoResultsRow

public String printNoResultsRow(Locale locale)

Deprecated.

Generates the HTML table body in the case when there are not any data rows to present. The message displayed is generated by a ResourceBundle entry NO_RESULTS_IN_TABLE in the ResourceBundle wt.templateutil.table.tableResource The alignment of the message is controlled by the properties file entry wt.htmltable.no.result.message.alignment.

Parameters:

locale -

setFormName

public void setFormName(String formName)

Deprecated.

getFormName

public String getFormName()

Deprecated.

getPDMLinkHTMLTable

public static PDMLinkHTMLTable getPDMLinkHTMLTable()
                                            throws WTException

Deprecated. This method is not currently used and is not going to be used.

Throws:

WTException

setPresentIconFirstRow

public void setPresentIconFirstRow(boolean presentIconFirstColumn)

Deprecated.

Sets the flag that determines if the "First Column" of the HTML table is to be presented.

The HTML Table presents one of two "First Columns"depending on the type of the TableModel

• TreeTableModel - A TreeTableColumn is used to generate the first column to present a Tree of the object's composition
• All other TabelModels - an Icon with a link to the Detail page of the the object being represented in the row (PDMLinkIconTableColumn is used)

The "First Column" is presented at the front of the table and in an additional column to the columns specified in the TableModel.

The default is true.

Supported API: true

Parameters:

presentIconFirstColumn - - sets flag for presenting first column

setPresentIconFirstNoLinkRow

public void setPresentIconFirstNoLinkRow(boolean presentIconFirstNoLinkColumn)

Deprecated.

isPresentIconFirstRow

public boolean isPresentIconFirstRow()

Deprecated.

Returns the flag that indicates if the "First Column" is to be presented.

isPresentIconFirstNoLinkRow

public boolean isPresentIconFirstNoLinkRow()

Deprecated.

setPresentActionsIconColumn

public void setPresentActionsIconColumn(boolean presentActionsIconColumn)

Deprecated.

Sets the flag the determines if the "Action Column" is to be presented. The "Action Column" presents a column where each row of the column presents Icons with links to Context Specific actions for the object being represented by that row. For example, if the third row of the HTML Table is presenting information on a checked out document, then the "Action Column" will have a cell with Icons (with links) representing available actions on that document.

The default is true.

Supported API: true

Parameters:

presentActionsIconColumn - - Sets flag that determines if the Action Column is to be presented.

isPresentActionsIconColumn

public boolean isPresentActionsIconColumn()

Deprecated.

Returns the flag that indicates if the "Action Column" is to be presented.

setIsSortingEnabled

public void setIsSortingEnabled(boolean isSortingEnabled)

Deprecated.

Sets the flag that tells the HTML Table is sorting on the columns is to be enabled or not. This can be set in HTML Template Processing script calls by calling the enableSorting method on BasicTableService.

Supported API: true

Parameters:

isSortingEnabled - - Sets flag to determine if sorting on the columns is enabled.

isSortingEnabled

public boolean isSortingEnabled()

Deprecated.

Returns the flag that determines if sorting is enabled on the columns of the HTML Table

setIsCollapsingEnabled

public void setIsCollapsingEnabled(boolean isCollapsingEnabled)

Deprecated.

Sets the flag that tells the HTML Table is hiding(collapsing) on the columns is to be enabled or not. This can be set in HTML Template Processing script calls by calling the enableColumnCollapse method on BasicTableService.

Supported API: true

Parameters:

isCollapsingEnabled - - Sets flag to determine if sorting on the columns is enabled.

isCollapsingEnabled

public boolean isCollapsingEnabled()

Deprecated.

Returns the flag that determines if hiding(collapsing) is enabled on the columns of the HTML Table

initCellComponent

protected HTMLComponent initCellComponent(HTMLComponent cellComponent,
                                          Object cellObject,
                                          int rowNumber,
                                          int column,
                                          Properties props)

Deprecated.