planetj.html
Class HTMLTable

java.lang.Object
  |
  +--planetj.html.HTMLElement
        |
        +--planetj.html.HTMLTable

public class HTMLTable

extends HTMLElement

This class is used for containing the properties of an HTML table into an object. A HTMLTAbleProperties object is used when outputing the HTML code for a table.

Author:

PlanetJ Corporation

Field Summary

static String	className
static String	LOCATION_ACTION_ROW_INLINE In-line row actions location.
static int	MULTIPLESELECTION
static int	NOSELECTION
static int	SINGLESELECTION
static String	STYLE_SHEET

Fields inherited from class planetj.html.HTMLElement

DISABLED

Constructor Summary

HTMLTable()
Creates a new HTMLTable object and sets its table id to the default.

HTMLTable(String rcId)
Creates a new HTMLTable object and sets its table id.

HTMLTable(String rcId, String rowId)
Creates a new HTMLTable object and sets its table id.

Method Summary

StringBuffer	appendBody(RowCollection pRC, List pFieldNames, StringBuffer html, javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse)
static StringBuffer	appendChartLinks(RowCollection rc, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Append links to view charts for given RowCollection.
StringBuffer	appendHeader(RowCollection pRC, List pFieldNames, StringBuffer html, javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse)
StringBuffer	appendMagicLinks(javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse, StringBuffer html, RowCollection pRC)
StringBuffer	appendMagicRow(javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse, StringBuffer html, RowCollection pRC)
StringBuffer	appendMagicRow(javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse, StringBuffer html, RowCollection pRC, boolean generatequicklinks)
StringBuffer	appendMagicRowFunctions(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, StringBuffer html, RowCollection pRC)
StringBuffer	appendNextPreviousLinks(boolean useExtraText, javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse, StringBuffer html, RowCollection pRC) Appends next and previous rows links to the given StringBuffer.
static StringBuffer	appendPrintLink(RowCollection rc, String printURI, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
StringBuffer	appendRow(int rowNum, int displayRowNum, OddEvenFlag oddEvenFlag, boolean isChildRow, Row row, List fieldNames, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
StringBuffer	appendRow(int rowNum, int displayRowNum, OddEvenFlag oddEvenFlag, Row row, List fieldNames, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
StringBuffer	appendRow(int rowNum, int displayRowNum, Row row, List fieldNames, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated. - replaced with appendRow that also takes in an OddEvenFlag object used to determine if the row being generated is odd or even
StringBuffer	appendStyleSheet(StringBuffer html)
String	generateTable(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generates HTML code for this HTMLTable object.
String	generateTable(javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse, RowCollection pRC, List pFieldNames) Deprecated. Replaced with generateTable(RowCollection, List, HttpServletRequest, HttpServletResponse)
String	generateTable(RowCollection rc, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generates HTML code for this HTML table using the specified rows (RowCollection).
String	generateTable(RowCollection rc, List names, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generates HTML code for this HTML table using the given RowCollection.
int	getBorder() Deprecated.
int	getCellPadding() Deprecated.
int	getCellSpacing() Deprecated.
String	getCopyLinkText()
String	getCopyURI()
String	getDeleteAllLinkText()
String	getDeleteLinkText()
String	getEditLinkText()
String	getEditURI()
List	getExcludedFieldNames()
List	getFieldNames()
int	getFirstRowIndex() Returns the mFirstRow.
int	getGridWidth() Deprecated.
String	getInsertLinkText()
String	getInsertURI()
String	getInternalPagingText() Gets the test used with internal paging to tell the user how many records there are
String	getNextPreviousJustify() Insert the method's description here.
String	getNoRecordsFoundText() Gets the text to display when there are no records
String	getPrintURI()
String	getRowId()
RowCollection	getRows() Returns the rows (RowCollection) to the table has for populating its data.
String	getRowSelectionJavascript() Gets the name of the Javascript function to call when a row is selected.
int	getRowsToDisplay() Returns the mRowsToDisplay.
int	getSelectionType() Insert the method's description here.
String	getStyleSheetLink()
String	getTableId() Returns the TableId of the specific table being generated Creation date: (8/5/2003 10:47:40 AM)
String	getUpdateLinkText()
String	getURI(javax.servlet.http.HttpServletRequest pRequest)
String	getViewURI()
boolean	isAllowDeleteAllRows() Deprecated. use isDisplayDeleteAllRows() instead
boolean	isAllowMultipleDelete()
boolean	isAllowNextAndPrevious() Deprecated. use isDisplayNextAndPrevious() instead
boolean	isAllowPrint() Deprecated. use isDisplayPrint() instead
boolean	isAllowRowCopy() Deprecated. use isDisplayRowCopy instead
boolean	isAllowViewDetails() Deprecated. use isDisplayViewDetails() instead
boolean	isColumnSortingEnabled() Deprecated. use isDisplaySortingLinks() instead
boolean	isCopyRCToTableLink() Creation date: (1/23/2002 4:52:01 PM)
boolean	isDataOnly() Return true if only the raw data should be returned for the table.
boolean	isDataOnly(javax.servlet.http.HttpServletRequest req) Return true if only the raw data should be returned for the table.
boolean	isDisplayChartLink() Checks to see if a chart link can be displayed.
boolean	isDisplayColumnHeaders() Tests if the column headers should be displayed
boolean	isDisplayDelete() Tests whether or not the Delete button should be displayed
boolean	isDisplayDeleteAllRows() Tests if the "Delete All" button should be displayed
boolean	isDisplayEdit() Tests if the Edit button should be displayed
boolean	isDisplayEditFDs() Tests if links for editing the field descriptor for columns should be displayed
boolean	isDisplayExcelLink() Tests if a link for viewing the table's contents in Excel should be displayed
boolean	isDisplayExcelXlsLink() Tests if a link for sending contents as Excel file should be displayed
boolean	isDisplayGrid() Tests if the gird spearating cells in the table should be displayed
boolean	isDisplayInsert() Tests if the Insert button should be displayed
boolean	isDisplayMagicLinks() Deprecated. because no one is calling it and isDisplayEditFDs() might return true even if no FD's are being displayed (because they are only displayed when an app is launched from the builder)
boolean	isDisplayMSAccessLink() Tests if a link for exporting the table's contents to MS Access should be displayed
boolean	isDisplayMSWordLink() Tests if a link for viewing the table's contents in MS Word should be displayed
boolean	isDisplayNextAndPrevious() Sets whether or not the "next" and "previous" links to the next and previous RowCollections should be displayed.
boolean	isDisplayPDFLink() Tests if a link for viewing the table's contents as a PDF should be displayed
boolean	isDisplayPrint() Tests if the Print magic link should be displayed
boolean	isDisplayRefresh() Tests if a link for refreshing the table should be displayed
boolean	isDisplayRemove() Tests if the Remove button should be displayed
boolean	isDisplayRemoveAll() Tests whether or not the Remove All button should be displayed
boolean	isDisplayRow(Row row) Determines if the Row should be displayed or not.
boolean	isDisplayRowCopy() Tests whether or not the HTML generated table should include the Copy Row button
boolean	isDisplaySortingLinks() Tests if links for sorting on a column of the table should be displayed
boolean	isDisplayUpdateableButton() This method was added as a temporary fix and should not be used for anything if possible.
boolean	isDisplayViewDetails() Tests if the View Details button should be displayed
boolean	isDisplayWhiteSortLinks() Tests if white sorting links should be used - the default is to use black ones
boolean	isDisplayXMLLink() Tests if a link for viewing the table's contents as XML should be displayed
boolean	isEditFDQuickLinkEnabled() Gets whether or not a quick link can be created to allow to navigation to the FDManager where a field/column's FD can be edited.
boolean	isIgnoreRowCollectionProperties() Check to see if the RowCollection's properties should be ignored when when generating results.
boolean	isInsertable() Tests if the table's contents can be inserted directly from the table.
boolean	isInternalPaging() Tests if we are using internal paging.
boolean	isMagicDelete() Deprecated. use isDisplayDelete() instead
boolean	isMagicEdit() Deprecated. use isDisplayEdit() instead
boolean	isMagicEditFDs() Deprecated. use isDisplayEditFDs() instead
boolean	isMagicExcelLink() Deprecated. use isDisplayExcelLink() instead
boolean	isMagicInsert() Deprecated. use isDisplayInsert() instead
boolean	isMagicMSWordLink() Deprecated. use isDisplayMSWordLink() instead
boolean	isMagicPDFLink() Deprecated. use isDisplayPDFLink() instead
boolean	isMagicRefresh() Deprecated. use isDisplayRefresh() instead
boolean	isMagicSortingLinks() Deprecated. use isDisplaySortingLinks() instead
boolean	isMagicXMLLink() Deprecated. use isDisplayXMLLink() instead
boolean	isMultipleSelection()
boolean	isNoSelection()
boolean	isSelectableRecords() Insert the method's description here.
boolean	isShowHeader() Deprecated. use isDisplayColumnHeaders() instead
boolean	isShowRowFunctionsOnLeftSide()
boolean	isShowRowFunctionsOnRightSide()
boolean	isShowSelection() !!TF by WK (11/7/2002 12:51:44 PM) remove after dynamic generic actions are complete.
boolean	isSingleSelection()
boolean	isUpdateable() Tests if the table's contents can be updated directly from the table.
boolean	isUsedDefaultCSS() Check to see if default results CSS should be included in generation when no request and response are provided.
boolean	isUseWhiteSortLinks()
boolean	isWrapHeaders() Check to see if column headers should be wrapped.
void	setAllMagicLinks(boolean onOrOff) Deprecated. use setAllTableLinks() instead
void	setAllowDeleteAllRows(boolean pAllowDeleteAllRows) Deprecated. use setDisplayDeleteAllRows() instead
void	setAllowMultipleDelete(boolean pAllowMultipleDelete)
void	setAllowNextAndPrevious(boolean pAllowNextAndPrevious) Deprecated. use setDisplayNextAndPrevious() instead
void	setAllowPrint(boolean pAllowPrint) Deprecated. use setDisplayPrint() instead
void	setAllowRowCopy(boolean pAllowRowCopy) Deprecated. use setDisplayRowCopy instead
void	setAllowViewDetails(boolean pAllowViewDetails) Deprecated. use setDisplayViewDetails() instead
void	setAllRowFunctions(boolean onOrOff) Convenience method to turn on or off all row functions
void	setAllTableLinks(boolean onOrOff) Convenience method to turn on or off all the magic links which operate on the contents of the entire table
void	setBorder(int newBorder) Deprecated.
void	setCellPadding(int newCellPadding) Deprecated.
void	setCellSpaceing(int newCellSpaceing) Deprecated.
void	setCopyRCToTableLink(boolean newCopyRCToTableLink) Creation date: (1/23/2002 4:52:01 PM)
void	setCopyURI(String copyURI)
void	setDataOnly(boolean dataOnly) Set true if only the raw data should be returned for the table.
void	setDeleteAllLinkText(String pDeleteAllLinkText) Sets text for delete all button.
void	setDeleteLinkText(String pDeleteLinkText) Sets text for delete button.
void	setDisplayChartLink(boolean displayChart) Sets if a chart link is able to be displayed.
void	setDisplayDelete(boolean pDisplayDelete) Sets whether or not the Delete button should be displayed
void	setDisplayDeleteAllRows(boolean pDisplayDeleteAllRows) Sets if the "Delete All" button should be displayed
void	setDisplayEdit(boolean pDisplayEdit) Sets if the Edit button should be displayed
void	setDisplayEditFDs(boolean pDisplayEditFDs) Sets if links for editing the field descriptor for columns should be displayed
void	setDisplayExcelLink(boolean newDisplayExcelLink) Sets if a link for viewing the table's contents in Excel should be displayed
void	setDisplayExcelXlsLink(boolean newDisplayExcelXlsLink) Sets if a link for sending table's contents as an Excel file should be displayed
void	setDisplayGrid(boolean pDisplayGrid) Sets if the grid separating cells of the table should be displayed
void	setDisplayInsert(boolean pDisplayInsert) Sets if the Insert button should be displayed
void	setDisplayMSAccessLink(boolean display) Tests if a link for exporting the table's contents to MS Access should be displayed
void	setDisplayMSWordLink(boolean newDisplayMSWordLink) Sets if a link for viewing the table's contents in MS Word should be displayed
void	setDisplayNextAndPrevious(boolean pDisplayNextAndPrevious) Sets whether or not the "next" and "previous" links to the next and previous RowCollections should be displayed.
void	setDisplayPDFLink(boolean newDisplayPDFLink) Sets if a link for viewing the table's contents as a PDF should be displayed
void	setDisplayPrint(boolean pDisplayPrint) Sets if the Print magic link should be displayed
void	setDisplayRefresh(boolean newDisplayRefresh) Sets if a link for refreshing the table should be displayed
void	setDisplayRemove(boolean remove) Sets if the Remove button should be displayed
void	setDisplayRemoveAll(boolean pRemoveAll) Sets if the Remove All button should be displayed
void	setDisplayRowCopy(boolean pDisplayRowCopy) Sets if the Copy Row button should be displayed
void	setDisplaySortingLinks(boolean newDisplaySortingLinks) Sets if links for sorting on a column of the table should be displayed
void	setDisplayUpdateableButton(boolean displayButton) This method was added as a temporary fix and should not be used for anything if possible.
void	setDisplayViewDetails(boolean pDisplayViewDetails) Sets if the View Details button should be displayed
void	setDisplayWhiteSortLinks(boolean usewhite) Sets if white sorting links should be displayed - the default is to display black ones
void	setDisplayXMLLink(boolean newDisplayXMLLink) Sets if a link for viewing the table's contents as XML should be displayed
void	setEditURI(String pEditURI)
void	setExcludedFieldNames(List names)
void	setFieldNames(List names)
void	setFirstRowIndex(int mFirstRow) Sets the mFirstRow.
void	setGridWidth(int width) Deprecated.
void	setIgnoreRowCollectionProperties(boolean ignore) Set whether or not to ignore the RowCollection's properties when generating results.
void	setInsertable(boolean insertable) Set table contents to allow or disallow inserting directly from the table.
void	setInsertLinkText(String pInsertLinkText) Sets text for insert button.
void	setInsertURI(String pInsertURI)
void	setInternalPagingText(String text) Sets the test used with internal paging to tell the user how many records there are
void	setMagicDelete(boolean pMagicDelete) Deprecated. Use setDisplayDelete() instead
void	setMagicEdit(boolean pMagicEdit) Deprecated. use setDisplayEdit() instead
void	setMagicEditFDs(boolean pMagicEditFDs) Deprecated. use setDisplayEditFDs() instead
void	setMagicExcelLink(boolean newMagicExcelLink) Deprecated. use setDisplayExcelLink() instead
void	setMagicInsert(boolean pMagicInsert) Deprecated. use setDisplayInsert() instead
void	setMagicMSWordLink(boolean newMagicMSWordLink) Deprecated. use setDisplayMSWordLink() instead
void	setMagicPDFLink(boolean newMagicPDFLink) Deprecated. use setDisplayPDFLink() instead
void	setMagicRefresh(boolean newMagicRefresh) Deprecated. use setDisplayRefresh() instead
void	setMagicSortingLinks(boolean newMagicSortingLinks) Deprecated. use setDisplaySortingLinks() instead
void	setMagicXMLLink(boolean newMagicXMLLink) Deprecated. use setDisplayXMLLink() instead
void	setNextPreviousJustify(String newNextPreviousJustify)
void	setNoRecordsFoundText(String text) Sets the text to display when there are no records
void	setPrintURI(String uri)
void	setProperties(ChartSpecificationPG chartSpecs) Sets any details display properties for this HTML table.
void	setProperties(DetailDisplayPropertyGroup properties) Sets any details display properties for this HTML table.
void	setProperties(DisplayColumnsPropertyGroup properties) Sets any display column properties for this HTML table.
void	setProperties(PropertyGroupList pList) Sets the properties of this HTML table.
void	setProperties(TableDisplayPropertyGroup pProperties)
void	setRowCollectionId(String rcId)
void	setRowId(String pRowId)
void	setRows(RowCollection rows) Sets the rows (RowCollection) to be used in populating the data for the table.
void	setRowsAndProperties(RowCollection rc, javax.servlet.http.HttpServletRequest request) Sets the rows (RowCollection) to be used in populating the data for the table.
void	setRowSelectionJavascript(String newRowSelectionJavascript) Sets the name of the Javascript function to call when a row is selected.
void	setRowsToDisplay(int mRowsToDisplay) Sets the mRowsToDisplay.
void	setSelectableRecords(boolean value) Insert the method's description here.
void	setSelectionType(int newSelectionType) Insert the method's description here.
void	setShowHeader(boolean pShowHeader)
void	setShowRowFunctionsOnLeftSide(boolean onOrOff)
void	setShowRowFunctionsOnRightSide(boolean onOrOff)
void	setShowSelection(boolean newMShowSelection) !!TF by WK (11/7/2002 12:52:32 PM) remove after dynamic generic actions are complete
void	setStyleSheetLink(String pStyleSheetLink)
void	setTableId(String newTableId) Set table Id where the newTableId is the variable being set to mTableId from the html table Used for excel web query.
void	setTableUpdateable(boolean pTableUpdateable) Deprecated. use setUpdateable() instead
void	setUpdateable(boolean pUpdateable) Sets if the table's contents can be updated directly from the table.
void	setUpdateLinkText(String pUpdateLinkText) Sets text for update button.
void	setURI(String pURI)
void	setUsedDefaultCSS(boolean include) Set whether or not the default results CSS should be included in generation when no request and response are provided.
void	setUseWhiteSortLinks(boolean usewhite) Deprecated. use setDisplayWhiteSortLinks() instead
void	setViewLinkText(String pViewLinkText) Sets text for view button.
void	setViewURI(String pViewURI)
void	setWrapHeaders(boolean wrap) Set whether or not column headers should be wrapped.

Methods inherited from class planetj.html.HTMLElement

appendAttribute, appendAttribute, appendExtractableHiddenField, getId, isDisplayField, setId

Methods inherited from class java.lang.Object

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

Field Detail

LOCATION_ACTION_ROW_INLINE

public static final String LOCATION_ACTION_ROW_INLINE

In-line row actions location.

See Also:

Constant Field Values

NOSELECTION

public static final int NOSELECTION

See Also:

Constant Field Values

SINGLESELECTION

public static final int SINGLESELECTION

See Also:

Constant Field Values

MULTIPLESELECTION

public static final int MULTIPLESELECTION

See Also:

Constant Field Values

STYLE_SHEET

public static final String STYLE_SHEET

See Also:

Constant Field Values

className

public static final String className

Constructor Detail

HTMLTable

public HTMLTable()

Creates a new HTMLTable object and sets its table id to the default.

HTMLTable

public HTMLTable(String rcId)

Creates a new HTMLTable object and sets its table id.

HTMLTable

public HTMLTable(String rcId,
                 String rowId)

Creates a new HTMLTable object and sets its table id.

Method Detail

appendBody

public StringBuffer appendBody(RowCollection pRC,
                               List pFieldNames,
                               StringBuffer html,
                               javax.servlet.http.HttpServletRequest pRequest,
                               javax.servlet.http.HttpServletResponse pResponse)
                        throws CMException

CMException

appendChartLinks

public static StringBuffer appendChartLinks(RowCollection rc,
                                            StringBuffer html,
                                            javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)
                                     throws CMException

Append links to view charts for given RowCollection.

CMException

appendHeader

public StringBuffer appendHeader(RowCollection pRC,
                                 List pFieldNames,
                                 StringBuffer html,
                                 javax.servlet.http.HttpServletRequest pRequest,
                                 javax.servlet.http.HttpServletResponse pResponse)
                          throws CMException

CMException

appendMagicLinks

public StringBuffer appendMagicLinks(javax.servlet.http.HttpServletRequest pRequest,
                                     javax.servlet.http.HttpServletResponse pResponse,
                                     StringBuffer html,
                                     RowCollection pRC)
                              throws DataEngineException

DataEngineException

appendMagicRow

public StringBuffer appendMagicRow(javax.servlet.http.HttpServletRequest pRequest,
                                   javax.servlet.http.HttpServletResponse pResponse,
                                   StringBuffer html,
                                   RowCollection pRC)
                            throws DataEngineException

DataEngineException

appendMagicRow

public StringBuffer appendMagicRow(javax.servlet.http.HttpServletRequest pRequest,
                                   javax.servlet.http.HttpServletResponse pResponse,
                                   StringBuffer html,
                                   RowCollection pRC,
                                   boolean generatequicklinks)
                            throws DataEngineException

DataEngineException

appendMagicRowFunctions

public StringBuffer appendMagicRowFunctions(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response,
                                            StringBuffer html,
                                            RowCollection pRC)

appendNextPreviousLinks

public StringBuffer appendNextPreviousLinks(boolean useExtraText,
                                            javax.servlet.http.HttpServletRequest pRequest,
                                            javax.servlet.http.HttpServletResponse pResponse,
                                            StringBuffer html,
                                            RowCollection pRC)

Appends next and previous rows links to the given StringBuffer.

appendPrintLink

public static StringBuffer appendPrintLink(RowCollection rc,
                                           String printURI,
                                           StringBuffer html,
                                           javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)

appendRow

public StringBuffer appendRow(int rowNum,
                              int displayRowNum,
                              Row row,
                              List fieldNames,
                              StringBuffer html,
                              javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws CMException

Deprecated. - replaced with appendRow that also takes in an OddEvenFlag object used to determine if the row being generated is odd or even

CMException

appendRow

public StringBuffer appendRow(int rowNum,
                              int displayRowNum,
                              OddEvenFlag oddEvenFlag,
                              Row row,
                              List fieldNames,
                              StringBuffer html,
                              javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws CMException

CMException

appendRow

public StringBuffer appendRow(int rowNum,
                              int displayRowNum,
                              OddEvenFlag oddEvenFlag,
                              boolean isChildRow,
                              Row row,
                              List fieldNames,
                              StringBuffer html,
                              javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws CMException

CMException

appendStyleSheet

public StringBuffer appendStyleSheet(StringBuffer html)

generateTable

public String generateTable(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws CMException

Generates HTML code for this HTMLTable object. Invoking this method requires that a RowCollection had previously been set on the HTMLTable object. This allows enables custom JSP's to change display properties of an HTMLTable object after the RowCollection's properties have been set.

Parameters:

request - HttpServletRequest

response - HttpServletResponse

Returns:

String

CMException

generateTable

public String generateTable(javax.servlet.http.HttpServletRequest pRequest,
                            javax.servlet.http.HttpServletResponse pResponse,
                            RowCollection pRC,
                            List pFieldNames)
                     throws CMException

Deprecated. Replaced with generateTable(RowCollection, List, HttpServletRequest, HttpServletResponse)

Generates HTML code for this HTML table using the specified rows (RowCollection).

Returns:

String

CMException

generateTable

public String generateTable(RowCollection rc,
                            List names,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws CMException

Generates HTML code for this HTML table using the given RowCollection.

Parameters:

rc - RowCollection to generate HTML for

names - list of names of columns to generate

request - HttpServletRequest from client

response - HttpServletResponse to client

Returns:

HTML for the given rows.

CMException

generateTable

public String generateTable(RowCollection rc,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws CMException

Generates HTML code for this HTML table using the specified rows (RowCollection).

Returns:

String

CMException

getBorder

public int getBorder()

Deprecated.

getCellPadding

public int getCellPadding()

Deprecated.

getCellSpacing

public int getCellSpacing()

Deprecated.

getCopyLinkText

public String getCopyLinkText()

getCopyURI

public String getCopyURI()

getDeleteAllLinkText

public String getDeleteAllLinkText()

getDeleteLinkText

public String getDeleteLinkText()

getEditLinkText

public String getEditLinkText()

getEditURI

public String getEditURI()

getExcludedFieldNames

public List getExcludedFieldNames()

getFieldNames

public List getFieldNames()

getFirstRowIndex

public int getFirstRowIndex()

Returns the mFirstRow.

Returns:

int

getGridWidth

public int getGridWidth()

Deprecated.

getInsertLinkText

public String getInsertLinkText()

getInsertURI

public String getInsertURI()

getInternalPagingText

public String getInternalPagingText()

Gets the test used with internal paging to tell the user how many records there are

getNextPreviousJustify

public String getNextPreviousJustify()

Insert the method's description here. Creation date: (8/19/01 4:30:37 PM)

Returns:

int

getNoRecordsFoundText

public String getNoRecordsFoundText()

Gets the text to display when there are no records

getPrintURI

public String getPrintURI()

getRowId

public String getRowId()

getRows

public RowCollection getRows()

Returns the rows (RowCollection) to the table has for populating its data.

Returns:

RowCollection

getRowSelectionJavascript

public String getRowSelectionJavascript()

Gets the name of the Javascript function to call when a row is selected. This should just be the function's name, without any parentheses. When the use makes a selection, the index of the selected row will be passed into this Javascript function.

getRowsToDisplay

public int getRowsToDisplay()

Returns the mRowsToDisplay.

Returns:

int

getSelectionType

public int getSelectionType()

Insert the method's description here. Creation date: (8/19/01 4:30:37 PM)

Returns:

int

getStyleSheetLink

public String getStyleSheetLink()

getTableId

public String getTableId()

Returns the TableId of the specific table being generated Creation date: (8/5/2003 10:47:40 AM)

Returns:

java.lang.String

getUpdateLinkText

public String getUpdateLinkText()

getURI

public String getURI(javax.servlet.http.HttpServletRequest pRequest)

getViewURI

public String getViewURI()

isAllowDeleteAllRows

public boolean isAllowDeleteAllRows()

Deprecated. use isDisplayDeleteAllRows() instead

isAllowMultipleDelete

public boolean isAllowMultipleDelete()

isAllowNextAndPrevious

public boolean isAllowNextAndPrevious()

Deprecated. use isDisplayNextAndPrevious() instead

isAllowPrint

public boolean isAllowPrint()

Deprecated. use isDisplayPrint() instead

isAllowRowCopy

public boolean isAllowRowCopy()

Deprecated. use isDisplayRowCopy instead

isAllowViewDetails

public boolean isAllowViewDetails()

Deprecated. use isDisplayViewDetails() instead

isColumnSortingEnabled

public boolean isColumnSortingEnabled()

Deprecated. use isDisplaySortingLinks() instead

isCopyRCToTableLink

public boolean isCopyRCToTableLink()

Creation date: (1/23/2002 4:52:01 PM)

Returns:

boolean

isDataOnly

public boolean isDataOnly()

Return true if only the raw data should be returned for the table.

isDataOnly

public boolean isDataOnly(javax.servlet.http.HttpServletRequest req)

Return true if only the raw data should be returned for the table.

isDisplayChartLink

public boolean isDisplayChartLink()

Checks to see if a chart link can be displayed.

isDisplayColumnHeaders

public boolean isDisplayColumnHeaders()

Tests if the column headers should be displayed

isDisplayDelete

public boolean isDisplayDelete()

Tests whether or not the Delete button should be displayed

isDisplayDeleteAllRows

public boolean isDisplayDeleteAllRows()

Tests if the "Delete All" button should be displayed

isDisplayEdit

public boolean isDisplayEdit()

Tests if the Edit button should be displayed

isDisplayEditFDs

public boolean isDisplayEditFDs()

Tests if links for editing the field descriptor for columns should be displayed

isDisplayExcelLink

public boolean isDisplayExcelLink()

Tests if a link for viewing the table's contents in Excel should be displayed

isDisplayExcelXlsLink

public boolean isDisplayExcelXlsLink()

Tests if a link for sending contents as Excel file should be displayed

isDisplayGrid

public boolean isDisplayGrid()

Tests if the gird spearating cells in the table should be displayed

isDisplayInsert

public boolean isDisplayInsert()

Tests if the Insert button should be displayed

isDisplayMagicLinks

public boolean isDisplayMagicLinks()
                            throws DataEngineException

Deprecated. because no one is calling it and isDisplayEditFDs() might return true even if no FD's are being displayed (because they are only displayed when an app is launched from the builder)

Tests if any magic links should be displayed. This method just looks at each individual magic link, and if any are set to be displayed,then it returns true

DataEngineException

isDisplayMSAccessLink

public boolean isDisplayMSAccessLink()

Tests if a link for exporting the table's contents to MS Access should be displayed

isDisplayMSWordLink

public boolean isDisplayMSWordLink()

Tests if a link for viewing the table's contents in MS Word should be displayed

isDisplayNextAndPrevious

public boolean isDisplayNextAndPrevious()

Sets whether or not the "next" and "previous" links to the next and previous RowCollections should be displayed.

isDisplayPDFLink

public boolean isDisplayPDFLink()

Tests if a link for viewing the table's contents as a PDF should be displayed

isDisplayPrint

public boolean isDisplayPrint()

Tests if the Print magic link should be displayed

isDisplayRefresh

public boolean isDisplayRefresh()

Tests if a link for refreshing the table should be displayed

isDisplayRemove

public boolean isDisplayRemove()

Tests if the Remove button should be displayed

isDisplayRemoveAll

public boolean isDisplayRemoveAll()

Tests whether or not the Remove All button should be displayed

isDisplayRow

public boolean isDisplayRow(Row row)

Determines if the Row should be displayed or not. By default, all rows are displayed, although subclasses may override this method.

isDisplayRowCopy

public boolean isDisplayRowCopy()

Tests whether or not the HTML generated table should include the Copy Row button

isDisplaySortingLinks

public boolean isDisplaySortingLinks()

Tests if links for sorting on a column of the table should be displayed

isDisplayUpdateableButton

public boolean isDisplayUpdateableButton()

This method was added as a temporary fix and should not be used for anything if possible.

isDisplayViewDetails

public boolean isDisplayViewDetails()

Tests if the View Details button should be displayed

isDisplayWhiteSortLinks

public boolean isDisplayWhiteSortLinks()

Tests if white sorting links should be used - the default is to use black ones

isDisplayXMLLink

public boolean isDisplayXMLLink()

Tests if a link for viewing the table's contents as XML should be displayed

isEditFDQuickLinkEnabled

public boolean isEditFDQuickLinkEnabled()

Gets whether or not a quick link can be created to allow to navigation to the FDManager where a field/column's FD can be edited.

isIgnoreRowCollectionProperties

public boolean isIgnoreRowCollectionProperties()

Check to see if the RowCollection's properties should be ignored when when generating results.

Returns:

true if RowCollection properties are to be ignored when generating results; false otherwise

isInsertable

public boolean isInsertable()

Tests if the table's contents can be inserted directly from the table.

isInternalPaging

public boolean isInternalPaging()

Tests if we are using internal paging. This is where all rows exist in one RowCollection, and each page displayed contains a subset of those rows

isMagicDelete

public boolean isMagicDelete()

Deprecated. use isDisplayDelete() instead

isMagicEdit

public boolean isMagicEdit()

Deprecated. use isDisplayEdit() instead

isMagicEditFDs

public boolean isMagicEditFDs()

Deprecated. use isDisplayEditFDs() instead

isMagicExcelLink

public boolean isMagicExcelLink()

Deprecated. use isDisplayExcelLink() instead

isMagicInsert

public boolean isMagicInsert()

Deprecated. use isDisplayInsert() instead

isMagicMSWordLink

public boolean isMagicMSWordLink()

Deprecated. use isDisplayMSWordLink() instead

isMagicPDFLink

public boolean isMagicPDFLink()

Deprecated. use isDisplayPDFLink() instead

isMagicRefresh

public boolean isMagicRefresh()

Deprecated. use isDisplayRefresh() instead

isMagicSortingLinks

public boolean isMagicSortingLinks()

Deprecated. use isDisplaySortingLinks() instead

isMagicXMLLink

public boolean isMagicXMLLink()

Deprecated. use isDisplayXMLLink() instead

isMultipleSelection

public boolean isMultipleSelection()

isNoSelection

public boolean isNoSelection()

isSelectableRecords

public boolean isSelectableRecords()

Insert the method's description here. Creation date: (2/7/2003 4:14:27 PM)

Returns:

boolean

isShowHeader

public boolean isShowHeader()

Deprecated. use isDisplayColumnHeaders() instead

isShowRowFunctionsOnLeftSide

public boolean isShowRowFunctionsOnLeftSide()

isShowRowFunctionsOnRightSide

public boolean isShowRowFunctionsOnRightSide()

isShowSelection

public boolean isShowSelection()

!!TF by WK (11/7/2002 12:51:44 PM) remove after dynamic generic actions are complete.

isSingleSelection

public boolean isSingleSelection()

isUpdateable

public boolean isUpdateable()

Tests if the table's contents can be updated directly from the table.

isUsedDefaultCSS

public boolean isUsedDefaultCSS()

Check to see if default results CSS should be included in generation when no request and response are provided.

isUseWhiteSortLinks

public boolean isUseWhiteSortLinks()

isWrapHeaders

public boolean isWrapHeaders()

Check to see if column headers should be wrapped.

setAllMagicLinks

public void setAllMagicLinks(boolean onOrOff)

Deprecated. use setAllTableLinks() instead

setAllowDeleteAllRows

public void setAllowDeleteAllRows(boolean pAllowDeleteAllRows)

Deprecated. use setDisplayDeleteAllRows() instead

setAllowMultipleDelete

public void setAllowMultipleDelete(boolean pAllowMultipleDelete)

setAllowNextAndPrevious

public void setAllowNextAndPrevious(boolean pAllowNextAndPrevious)

Deprecated. use setDisplayNextAndPrevious() instead

setAllowPrint

public void setAllowPrint(boolean pAllowPrint)

Deprecated. use setDisplayPrint() instead

setAllowRowCopy

public void setAllowRowCopy(boolean pAllowRowCopy)

Deprecated. use setDisplayRowCopy instead

setAllowViewDetails

public void setAllowViewDetails(boolean pAllowViewDetails)

Deprecated. use setDisplayViewDetails() instead

setAllRowFunctions

public void setAllRowFunctions(boolean onOrOff)

Convenience method to turn on or off all row functions

setAllTableLinks

public void setAllTableLinks(boolean onOrOff)

Convenience method to turn on or off all the magic links which operate on the contents of the entire table

setBorder

public void setBorder(int newBorder)

Deprecated.

setCellPadding

public void setCellPadding(int newCellPadding)

Deprecated.

setCellSpaceing

public void setCellSpaceing(int newCellSpaceing)

Deprecated.

setCopyRCToTableLink

public void setCopyRCToTableLink(boolean newCopyRCToTableLink)

Creation date: (1/23/2002 4:52:01 PM)

Parameters:

newCopyRCToTableLink - boolean

setCopyURI

public void setCopyURI(String copyURI)

setDataOnly

public void setDataOnly(boolean dataOnly)

Set true if only the raw data should be returned for the table.

setDeleteAllLinkText

public void setDeleteAllLinkText(String pDeleteAllLinkText)

Sets text for delete all button.

setDeleteLinkText

public void setDeleteLinkText(String pDeleteLinkText)

Sets text for delete button.

setDisplayChartLink

public void setDisplayChartLink(boolean displayChart)

Sets if a chart link is able to be displayed.

setDisplayDelete

public void setDisplayDelete(boolean pDisplayDelete)

Sets whether or not the Delete button should be displayed

setDisplayDeleteAllRows

public void setDisplayDeleteAllRows(boolean pDisplayDeleteAllRows)

Sets if the "Delete All" button should be displayed

setDisplayEdit

public void setDisplayEdit(boolean pDisplayEdit)

Sets if the Edit button should be displayed

setDisplayEditFDs

public void setDisplayEditFDs(boolean pDisplayEditFDs)

Sets if links for editing the field descriptor for columns should be displayed

setDisplayExcelLink

public void setDisplayExcelLink(boolean newDisplayExcelLink)

Sets if a link for viewing the table's contents in Excel should be displayed

setDisplayExcelXlsLink

public void setDisplayExcelXlsLink(boolean newDisplayExcelXlsLink)

Sets if a link for sending table's contents as an Excel file should be displayed

setDisplayGrid

public void setDisplayGrid(boolean pDisplayGrid)

Sets if the grid separating cells of the table should be displayed

setDisplayInsert

public void setDisplayInsert(boolean pDisplayInsert)

Sets if the Insert button should be displayed

setDisplayMSAccessLink

public void setDisplayMSAccessLink(boolean display)

Tests if a link for exporting the table's contents to MS Access should be displayed

setDisplayMSWordLink

public void setDisplayMSWordLink(boolean newDisplayMSWordLink)

Sets if a link for viewing the table's contents in MS Word should be displayed

setDisplayNextAndPrevious

public void setDisplayNextAndPrevious(boolean pDisplayNextAndPrevious)

Sets whether or not the "next" and "previous" links to the next and previous RowCollections should be displayed.

setDisplayPDFLink

public void setDisplayPDFLink(boolean newDisplayPDFLink)

Sets if a link for viewing the table's contents as a PDF should be displayed

setDisplayPrint

public void setDisplayPrint(boolean pDisplayPrint)

Sets if the Print magic link should be displayed

setDisplayRefresh

public void setDisplayRefresh(boolean newDisplayRefresh)

Sets if a link for refreshing the table should be displayed

setDisplayRemove

public void setDisplayRemove(boolean remove)

Sets if the Remove button should be displayed

setDisplayRemoveAll

public void setDisplayRemoveAll(boolean pRemoveAll)

Sets if the Remove All button should be displayed

setDisplayRowCopy

public void setDisplayRowCopy(boolean pDisplayRowCopy)

Sets if the Copy Row button should be displayed

setDisplaySortingLinks

public void setDisplaySortingLinks(boolean newDisplaySortingLinks)

Sets if links for sorting on a column of the table should be displayed

setDisplayUpdateableButton

public void setDisplayUpdateableButton(boolean displayButton)

This method was added as a temporary fix and should not be used for anything if possible.

setDisplayViewDetails

public void setDisplayViewDetails(boolean pDisplayViewDetails)

Sets if the View Details button should be displayed

setDisplayWhiteSortLinks

public void setDisplayWhiteSortLinks(boolean usewhite)

Sets if white sorting links should be displayed - the default is to display black ones

setDisplayXMLLink

public void setDisplayXMLLink(boolean newDisplayXMLLink)

Sets if a link for viewing the table's contents as XML should be displayed

setEditURI

public void setEditURI(String pEditURI)

setExcludedFieldNames

public void setExcludedFieldNames(List names)

setFieldNames

public void setFieldNames(List names)

setFirstRowIndex

public void setFirstRowIndex(int mFirstRow)

Sets the mFirstRow.

Parameters:

mFirstRow - The mFirstRow to set

setGridWidth

public void setGridWidth(int width)

Deprecated.

setIgnoreRowCollectionProperties

public void setIgnoreRowCollectionProperties(boolean ignore)

Set whether or not to ignore the RowCollection's properties when generating results.

Parameters:

ignore - flag to indicate if RowCollection properties are ignored when generating results

setInsertable

public void setInsertable(boolean insertable)

Set table contents to allow or disallow inserting directly from the table.

setInsertLinkText

public void setInsertLinkText(String pInsertLinkText)

Sets text for insert button.

setInsertURI

public void setInsertURI(String pInsertURI)

setInternalPagingText

public void setInternalPagingText(String text)

Sets the test used with internal paging to tell the user how many records there are

setMagicDelete

public void setMagicDelete(boolean pMagicDelete)

Deprecated. Use setDisplayDelete() instead

setMagicEdit

public void setMagicEdit(boolean pMagicEdit)

Deprecated. use setDisplayEdit() instead

setMagicEditFDs

public void setMagicEditFDs(boolean pMagicEditFDs)

Deprecated. use setDisplayEditFDs() instead

setMagicExcelLink

public void setMagicExcelLink(boolean newMagicExcelLink)

Deprecated. use setDisplayExcelLink() instead

setMagicInsert

public void setMagicInsert(boolean pMagicInsert)

Deprecated. use setDisplayInsert() instead

setMagicMSWordLink

public void setMagicMSWordLink(boolean newMagicMSWordLink)

Deprecated. use setDisplayMSWordLink() instead

setMagicPDFLink

public void setMagicPDFLink(boolean newMagicPDFLink)

Deprecated. use setDisplayPDFLink() instead

setMagicRefresh

public void setMagicRefresh(boolean newMagicRefresh)

Deprecated. use setDisplayRefresh() instead

setMagicSortingLinks

public void setMagicSortingLinks(boolean newMagicSortingLinks)

Deprecated. use setDisplaySortingLinks() instead

setMagicXMLLink

public void setMagicXMLLink(boolean newMagicXMLLink)

Deprecated. use setDisplayXMLLink() instead

setNextPreviousJustify

public void setNextPreviousJustify(String newNextPreviousJustify)

setNoRecordsFoundText

public void setNoRecordsFoundText(String text)

Sets the text to display when there are no records

setPrintURI

public void setPrintURI(String uri)

setProperties

public void setProperties(ChartSpecificationPG chartSpecs)

Sets any details display properties for this HTML table. (e.g. - pages to call for insert, edit, view, copy)

setProperties

public void setProperties(DetailDisplayPropertyGroup properties)

Sets any details display properties for this HTML table. (e.g. - pages to call for insert, edit, view, copy)

setProperties

public void setProperties(DisplayColumnsPropertyGroup properties)

Sets any display column properties for this HTML table.

setProperties

public void setProperties(TableDisplayPropertyGroup pProperties)

setProperties

public void setProperties(PropertyGroupList pList)

Sets the properties of this HTML table. This is done by getting the "TableDisplay" PropertyGroup objects out of the list and passing them to the setProperties(TableDisplayPropertyGroup) method.

setRowCollectionId

public void setRowCollectionId(String rcId)

setRowId

public void setRowId(String pRowId)

setRows

public void setRows(RowCollection rows)

Sets the rows (RowCollection) to be used in populating the data for the table.

Parameters:

rows - RowCollection

setRowsAndProperties

public void setRowsAndProperties(RowCollection rc,
                                 javax.servlet.http.HttpServletRequest request)

Sets the rows (RowCollection) to be used in populating the data for the table.

setRowSelectionJavascript

public void setRowSelectionJavascript(String newRowSelectionJavascript)

Sets the name of the Javascript function to call when a row is selected. This should just be the function's name, without any parentheses. When the use makes a selection, the index of the selected row will be passed into this Javascript function.

setRowsToDisplay

public void setRowsToDisplay(int mRowsToDisplay)

Sets the mRowsToDisplay.

Parameters:

mRowsToDisplay - The mRowsToDisplay to set

setSelectableRecords

public void setSelectableRecords(boolean value)

Insert the method's description here. Creation date: (2/7/2003 4:15:06 PM)

Parameters:

value - boolean

setSelectionType

public void setSelectionType(int newSelectionType)

Insert the method's description here. Creation date: (8/19/01 4:30:37 PM)

Parameters:

newSelectionType - int

setShowHeader

public void setShowHeader(boolean pShowHeader)

setShowRowFunctionsOnLeftSide

public void setShowRowFunctionsOnLeftSide(boolean onOrOff)

setShowRowFunctionsOnRightSide

public void setShowRowFunctionsOnRightSide(boolean onOrOff)

setShowSelection

public void setShowSelection(boolean newMShowSelection)

!!TF by WK (11/7/2002 12:52:32 PM) remove after dynamic generic actions are complete

setStyleSheetLink

public void setStyleSheetLink(String pStyleSheetLink)

setTableId

public void setTableId(String newTableId)

Set table Id where the newTableId is the variable being set to mTableId from the html table Used for excel web query. Creation date: (8/5/2003 10:49:54 AM)

setTableUpdateable

public void setTableUpdateable(boolean pTableUpdateable)

Deprecated. use setUpdateable() instead

setUpdateable

public void setUpdateable(boolean pUpdateable)

Sets if the table's contents can be updated directly from the table.

setUpdateLinkText

public void setUpdateLinkText(String pUpdateLinkText)

Sets text for update button.

setURI

public void setURI(String pURI)

setUsedDefaultCSS

public void setUsedDefaultCSS(boolean include)

Set whether or not the default results CSS should be included in generation when no request and response are provided. Defaults to true.

Parameters:

include - true if default CSS should be included in generation; false otherwise

setUseWhiteSortLinks

public void setUseWhiteSortLinks(boolean usewhite)

Deprecated. use setDisplayWhiteSortLinks() instead

setViewLinkText

public void setViewLinkText(String pViewLinkText)

Sets text for view button.

setViewURI

public void setViewURI(String pViewURI)

setWrapHeaders

public void setWrapHeaders(boolean wrap)

Set whether or not column headers should be wrapped.