Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

planetj.html
Class HTMLTable

java.lang.Object
  extended byplanetj.html.HTMLElement
      extended byplanetj.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 java.lang.String className
           
static int MULTIPLESELECTION
           
static int NOSELECTION
           
static int SINGLESELECTION
           
static java.lang.String STYLE_SHEET
           
 
Fields inherited from class planetj.html.HTMLElement
DISABLED, FOCUS_HTML_INPUT
 
Constructor Summary
HTMLTable()
          Creates a new HTMLTable object and sets its table id to the default.
HTMLTable(java.lang.String rcId)
          Creates a new HTMLTable object and sets its table id.
HTMLTable(java.lang.String rcId, java.lang.String rowId)
          Creates a new HTMLTable object and sets its table id.
 
Method Summary
 void addAction(AbstractAction action)
          Adds the specified action to this HTMLTable.
 java.lang.StringBuffer appendBody(RowCollection pRC, java.util.List pFieldNames, java.lang.StringBuffer html, HttpServletRequest pRequest, HttpServletResponse pResponse)
           
static java.lang.StringBuffer appendChartLinks(RowCollection rc, java.lang.StringBuffer html, HttpServletRequest request, HttpServletResponse response)
          Append links to view charts for given RowCollection.
static java.lang.StringBuffer appendEditFDQuickLink(Table table, java.lang.String fieldName, java.lang.StringBuffer html, HttpServletRequest request, HttpServletResponse response)
          Appends a link to navigate to the FDManager to edit a FD for a given column/field.
 java.lang.StringBuffer appendField(Field field, boolean isLeft, boolean isTop, int colspan, java.lang.StringBuffer html, HttpServletRequest request, HttpServletResponse response)
           
 java.lang.StringBuffer appendFieldInput(java.lang.String id, Field field, int size, int size2, java.lang.String attributes, java.lang.String rcNavKey, java.lang.String rowNavKey, java.lang.StringBuffer html, HttpServletRequest request, HttpServletResponse response)
          Method should be called when appending a Field's input.
 java.lang.StringBuffer appendHeader(RowCollection pRC, java.util.List pFieldNames, java.lang.StringBuffer html, HttpServletRequest pRequest, HttpServletResponse pResponse)
           
 java.lang.StringBuffer appendMagicLinks(HttpServletRequest pRequest, HttpServletResponse pResponse, java.lang.StringBuffer html, RowCollection pRC)
           
 java.lang.StringBuffer appendMagicRow(HttpServletRequest pRequest, HttpServletResponse pResponse, java.lang.StringBuffer html, RowCollection pRC)
           
 java.lang.StringBuffer appendMagicRow(HttpServletRequest request, HttpServletResponse response, java.lang.StringBuffer html, RowCollection rc, boolean generatequicklinks)
           
 java.lang.StringBuffer appendMagicRowFunctionsCell(HttpServletRequest pRequest, HttpServletResponse pResponse, java.lang.StringBuffer html, RowCollection pRC)
           
 java.lang.StringBuffer appendNextPreviousLinks(boolean useExtraText, HttpServletRequest request, HttpServletResponse response, java.lang.StringBuffer html, RowCollection pRC)
          Deprecated. - paging changed, use appendPagingLinks(RowCollection, StringBuffer, HttpServletRequest, HttpServletResponse)
static java.lang.StringBuffer appendPrintLink(RowCollection rc, java.lang.String printURI, java.lang.StringBuffer html, HttpServletRequest request, HttpServletResponse response)
           
 java.lang.StringBuffer appendRow(int rowNum, int displayRowNum, OddEvenFlag oddEvenFlag, boolean isChildRow, Row row, java.util.List fieldNames, java.lang.StringBuffer html, HttpServletRequest request, HttpServletResponse response)
           
 java.lang.StringBuffer appendRow(int rowNum, int displayRowNum, OddEvenFlag oddEvenFlag, Row row, java.util.List fieldNames, java.lang.StringBuffer html, HttpServletRequest request, HttpServletResponse response)
           
 java.lang.StringBuffer appendRow(int rowNum, int displayRowNum, Row row, java.util.List fieldNames, java.lang.StringBuffer html, HttpServletRequest request, 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
 java.lang.StringBuffer appendStyleSheet(java.lang.StringBuffer html)
           
 java.lang.String generateTable(HttpServletRequest request, HttpServletResponse response)
          Generates HTML code for this HTMLTable object.
 java.lang.String generateTable(RowCollection rc, HttpServletRequest request, HttpServletResponse response)
          Generates HTML code for this HTML table using the specified rows (RowCollection).
 java.lang.String generateTable(RowCollection rc, java.util.List names, HttpServletRequest request, HttpServletResponse response)
          Generates HTML code for this HTML table using the given RowCollection.
 AbstractAction getAction(java.lang.String location, java.lang.String actionName)
          Get a list of actions for generation
 java.util.List getActions(java.lang.String location)
          Get a list of actions for generation
 int getBorder()
          Deprecated.  
 int getCellPadding()
          Deprecated.  
 int getCellSpacing()
          Deprecated.  
 java.lang.String getCopyLinkText()
           
 java.lang.String getCopyURI()
           
 java.lang.String getDeleteAllLinkText()
           
 java.lang.String getDeleteLinkText()
           
 java.lang.String getEditLinkText()
           
 java.lang.String getEditURI()
           
 java.util.List getExcludedFieldNames()
           
 java.util.List getFieldNames()
           
 int getFirstRowIndex()
          Returns the mFirstRow.
 int getGridWidth()
          Deprecated.  
 java.lang.String getInsertLinkText()
           
 java.lang.String getInsertURI()
           
 java.lang.String getInternalPagingText()
          Gets the test used with internal paging to tell the user how many records there are
 java.lang.String getNextPreviousJustify()
          Insert the method's description here.
 java.lang.String getNoRecordsFoundText()
          Gets the text to display when there are no records
 java.lang.String getPrintURI()
           
 java.lang.String getRowId()
           
 RowCollection getRows()
          Returns the rows (RowCollection) to the table has for populating its data.
 java.lang.String getRowSelectionJavascript()
          Gets the name of the Javascript function to call when a row is selected.
 int getRowsToDisplay()
          Returns the mRowsToDisplay.
 java.util.List getSelectedRows()
          Gets the rows which should be rendered as already being selected
 int getSelectionType()
          Insert the method's description here.
 java.lang.String getStyleSheetLink()
           
 java.lang.String getTableId()
          Returns the TableId of the specific table being generated Creation date: (8/5/2003 10:47:40 AM)
 java.lang.String getTableWidth()
          Specifies the width of the table - .
 java.lang.String getUpdateLinkText()
           
 java.lang.String getURI(HttpServletRequest pRequest)
           
 java.lang.String getViewURI()
           
 boolean hasQuickLinks(RowCollection rc, HttpServletRequest request)
          Check whether or not there are any quick links.
 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(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 isFieldEditable(Field field, Row row, ExecutingContext ec, HttpServletRequest request)
          Tests to see if the specified field is editable in the table.
 boolean isIgnoreRowCollectionProperties()
          Check to see if the RowCollection's properties should be ignored when when generating results.
 boolean isIncludeDataEngineJS()
          Check if DataEngien JavaScript should be generated along with any HTML elements by this HTML table generator.
 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 all of the table's contents can be updated directly from the table.
 boolean isUpdateable(java.lang.String columnName)
          Deprecated. Use the isFieldEditable(Field,Row,ExecutingContext,HttpServletRequest) method instead
 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 prepareActions(RowCollection rc, ExecutingContext ec)
          Creates the actions that will be generated with this table.
 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 setCopyLinkText(java.lang.String pCopyLinkText)
          Sets text for copy button.
 void setCopyRCToTableLink(boolean newCopyRCToTableLink)
          Creation date: (1/23/2002 4:52:01 PM)
 void setCopyURI(java.lang.String copyURI)
           
 void setDataOnly(boolean dataOnly)
          Set true if only the raw data should be returned for the table.
 void setDeleteAllLinkText(java.lang.String pDeleteAllLinkText)
          Sets text for delete all button.
 void setDeleteLinkText(java.lang.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 setEditableFieldNames(java.util.List fieldNames)
          Sets the names of the fields which this table allows to be edited.
 void setEditLinkText(java.lang.String pEditLinkText)
          Sets text for edit button.
 void setEditURI(java.lang.String pEditURI)
           
 void setExcludedFieldNames(java.util.List names)
           
 void setFieldNames(java.util.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 setIncludeDataEngineJS(boolean includeDataEngineJS)
          Check if DataEngien JavaScript should be generated along with any HTML elements by this HTML table generator.
 void setInsertable(boolean insertable)
          Set table contents to allow or disallow inserting directly from the table.
 void setInsertLinkText(java.lang.String pInsertLinkText)
          Sets text for insert button.
 void setInsertURI(java.lang.String pInsertURI)
           
 void setInternalPagingText(java.lang.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(java.lang.String newNextPreviousJustify)
           
 void setNoRecordsFoundText(java.lang.String text)
          Sets the text to display when there are no records
 void setPrintURI(java.lang.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(java.lang.String rcId)
           
 void setRowId(java.lang.String pRowId)
           
 void setRows(RowCollection rows)
          Sets the rows (RowCollection) to be used in populating the data for the table.
 void setRowsAndProperties(RowCollection rc, HttpServletRequest request)
          Sets the rows (RowCollection) to be used in populating the data for the table.
 void setRowSelectionJavascript(java.lang.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 setSelectedRows(java.util.List rows)
          Sets the rows which should be rendered as already being selected
 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(java.lang.String pStyleSheetLink)
           
 void setTableId(java.lang.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 setTableWidth(java.lang.String newTableWidth)
          Sets the width of the table - .
 void setUpdateable(boolean pUpdateable)
          Sets if all of the table's contents can be updated directly from the table.
 void setUpdateableFieldNames(java.util.List fieldNames)
          Deprecated. To avoid confusion this method has been renamed setEditableFieldNames
 void setUpdateLinkText(java.lang.String pUpdateLinkText)
          Sets text for update button.
 void setURI(java.lang.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(java.lang.String pViewLinkText)
          Sets text for view button.
 void setViewURI(java.lang.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, getFocusHTMLInput, getId, isDisplayField, setFocusHTMLInput, setId
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

className

public static final java.lang.String className

MULTIPLESELECTION

public static final int MULTIPLESELECTION
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

STYLE_SHEET

public static final java.lang.String STYLE_SHEET
See Also:
Constant Field Values
Constructor Detail

HTMLTable

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

HTMLTable

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

HTMLTable

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

Method Detail

appendChartLinks

public static java.lang.StringBuffer appendChartLinks(RowCollection rc,
                                                      java.lang.StringBuffer html,
                                                      HttpServletRequest request,
                                                      HttpServletResponse response)
                                               throws CMException
Append links to view charts for given RowCollection.

Throws:
CMException

appendEditFDQuickLink

public static java.lang.StringBuffer appendEditFDQuickLink(Table table,
                                                           java.lang.String fieldName,
                                                           java.lang.StringBuffer html,
                                                           HttpServletRequest request,
                                                           HttpServletResponse response)
                                                    throws DataEngineException
Appends a link to navigate to the FDManager to edit a FD for a given column/field. If no field name is specified, then the link is for the table.

Throws:
DataEngineException

appendPrintLink

public static java.lang.StringBuffer appendPrintLink(RowCollection rc,
                                                     java.lang.String printURI,
                                                     java.lang.StringBuffer html,
                                                     HttpServletRequest request,
                                                     HttpServletResponse response)

addAction

public final void addAction(AbstractAction action)
Adds the specified action to this HTMLTable.

appendBody

public final java.lang.StringBuffer appendBody(RowCollection pRC,
                                               java.util.List pFieldNames,
                                               java.lang.StringBuffer html,
                                               HttpServletRequest pRequest,
                                               HttpServletResponse pResponse)
                                        throws CMException
Throws:
CMException

appendField

public java.lang.StringBuffer appendField(Field field,
                                          boolean isLeft,
                                          boolean isTop,
                                          int colspan,
                                          java.lang.StringBuffer html,
                                          HttpServletRequest request,
                                          HttpServletResponse response)
                                   throws CMException
Throws:
CMException

appendFieldInput

public final java.lang.StringBuffer appendFieldInput(java.lang.String id,
                                                     Field field,
                                                     int size,
                                                     int size2,
                                                     java.lang.String attributes,
                                                     java.lang.String rcNavKey,
                                                     java.lang.String rowNavKey,
                                                     java.lang.StringBuffer html,
                                                     HttpServletRequest request,
                                                     HttpServletResponse response)
                                              throws CMException
Method should be called when appending a Field's input. This ensures necessary JavaScript objects include for the Field.

Throws:
CMException

appendHeader

public java.lang.StringBuffer appendHeader(RowCollection pRC,
                                           java.util.List pFieldNames,
                                           java.lang.StringBuffer html,
                                           HttpServletRequest pRequest,
                                           HttpServletResponse pResponse)
                                    throws CMException
Throws:
CMException

appendMagicLinks

public java.lang.StringBuffer appendMagicLinks(HttpServletRequest pRequest,
                                               HttpServletResponse pResponse,
                                               java.lang.StringBuffer html,
                                               RowCollection pRC)
                                        throws DataEngineException
Throws:
DataEngineException

appendMagicRow

public final java.lang.StringBuffer appendMagicRow(HttpServletRequest pRequest,
                                                   HttpServletResponse pResponse,
                                                   java.lang.StringBuffer html,
                                                   RowCollection pRC)
                                            throws DataEngineException
Throws:
DataEngineException

appendMagicRow

public final java.lang.StringBuffer appendMagicRow(HttpServletRequest request,
                                                   HttpServletResponse response,
                                                   java.lang.StringBuffer html,
                                                   RowCollection rc,
                                                   boolean generatequicklinks)
                                            throws DataEngineException
Throws:
DataEngineException

appendMagicRowFunctionsCell

public java.lang.StringBuffer appendMagicRowFunctionsCell(HttpServletRequest pRequest,
                                                          HttpServletResponse pResponse,
                                                          java.lang.StringBuffer html,
                                                          RowCollection pRC)

appendNextPreviousLinks

public final java.lang.StringBuffer appendNextPreviousLinks(boolean useExtraText,
                                                            HttpServletRequest request,
                                                            HttpServletResponse response,
                                                            java.lang.StringBuffer html,
                                                            RowCollection pRC)
Deprecated. - paging changed, use appendPagingLinks(RowCollection, StringBuffer, HttpServletRequest, HttpServletResponse)

Appends next and previous rows links to the given StringBuffer.

appendRow

public java.lang.StringBuffer appendRow(int rowNum,
                                        int displayRowNum,
                                        OddEvenFlag oddEvenFlag,
                                        boolean isChildRow,
                                        Row row,
                                        java.util.List fieldNames,
                                        java.lang.StringBuffer html,
                                        HttpServletRequest request,
                                        HttpServletResponse response)
                                 throws CMException
Throws:
CMException

appendRow

public final java.lang.StringBuffer appendRow(int rowNum,
                                              int displayRowNum,
                                              OddEvenFlag oddEvenFlag,
                                              Row row,
                                              java.util.List fieldNames,
                                              java.lang.StringBuffer html,
                                              HttpServletRequest request,
                                              HttpServletResponse response)
                                       throws CMException
Throws:
CMException

appendRow

public final java.lang.StringBuffer appendRow(int rowNum,
                                              int displayRowNum,
                                              Row row,
                                              java.util.List fieldNames,
                                              java.lang.StringBuffer html,
                                              HttpServletRequest request,
                                              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

Throws:
CMException

appendStyleSheet

public java.lang.StringBuffer appendStyleSheet(java.lang.StringBuffer html)

generateTable

public final java.lang.String generateTable(HttpServletRequest request,
                                            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
Throws:
CMException

generateTable

public final java.lang.String generateTable(RowCollection rc,
                                            HttpServletRequest request,
                                            HttpServletResponse response)
                                     throws CMException
Generates HTML code for this HTML table using the specified rows (RowCollection).

Returns:
String
Throws:
CMException

generateTable

public java.lang.String generateTable(RowCollection rc,
                                      java.util.List names,
                                      HttpServletRequest request,
                                      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.
Throws:
CMException

getAction

public final AbstractAction getAction(java.lang.String location,
                                      java.lang.String actionName)
Get a list of actions for generation

Parameters:
location - where actions are to be generated on table

getActions

public final java.util.List getActions(java.lang.String location)
Get a list of actions for generation

Parameters:
location - where actions are to be generated on table

getBorder

public int getBorder()
Deprecated.  

getCellPadding

public int getCellPadding()
Deprecated.  

getCellSpacing

public int getCellSpacing()
Deprecated.  

getCopyLinkText

public java.lang.String getCopyLinkText()

getCopyURI

public java.lang.String getCopyURI()

getDeleteAllLinkText

public java.lang.String getDeleteAllLinkText()

getDeleteLinkText

public java.lang.String getDeleteLinkText()

getEditLinkText

public java.lang.String getEditLinkText()

getEditURI

public java.lang.String getEditURI()

getExcludedFieldNames

public java.util.List getExcludedFieldNames()

getFieldNames

public java.util.List getFieldNames()

getFirstRowIndex

public int getFirstRowIndex()
Returns the mFirstRow.

Returns:
int

getGridWidth

public int getGridWidth()
Deprecated.  

getInsertLinkText

public java.lang.String getInsertLinkText()

getInsertURI

public java.lang.String getInsertURI()

getInternalPagingText

public java.lang.String getInternalPagingText()
Gets the test used with internal paging to tell the user how many records there are

getNextPreviousJustify

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

Returns:
int

getNoRecordsFoundText

public java.lang.String getNoRecordsFoundText()
Gets the text to display when there are no records

getPrintURI

public java.lang.String getPrintURI()

getRowId

public java.lang.String getRowId()

getRows

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

Returns:
RowCollection

getRowSelectionJavascript

public java.lang.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

getSelectedRows

public java.util.List getSelectedRows()
Gets the rows which should be rendered as already being selected

getSelectionType

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

Returns:
int

getStyleSheetLink

public java.lang.String getStyleSheetLink()

getTableId

public java.lang.String getTableId()
Returns the TableId of the specific table being generated Creation date: (8/5/2003 10:47:40 AM)

Returns:
java.lang.String

getTableWidth

public java.lang.String getTableWidth()
Specifies the width of the table - . The default is "0" (no table width attribute) !!A KGetting (12/05/2005)

getUpdateLinkText

public java.lang.String getUpdateLinkText()

getURI

public java.lang.String getURI(HttpServletRequest pRequest)

getViewURI

public java.lang.String getViewURI()

hasQuickLinks

public boolean hasQuickLinks(RowCollection rc,
                             HttpServletRequest request)
Check whether or not there are any quick links.

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(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

Throws:
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.

isFieldEditable

public boolean isFieldEditable(Field field,
                               Row row,
                               ExecutingContext ec,
                               HttpServletRequest request)
Tests to see if the specified field is editable in the table. This method takes into account all the operation properties, as well as the current status of the row & field and is the final calculation to determine whether or not an input field will be used to display this field's contents.

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

isIncludeDataEngineJS

public boolean isIncludeDataEngineJS()
Check if DataEngien JavaScript should be generated along with any HTML elements by this HTML table generator.

Returns:

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 all of the table's contents can be updated directly from the table. (This method just checks with the table to see if it allows updates; the table's contents may not allow themselves to be updated.)

isUpdateable

public boolean isUpdateable(java.lang.String columnName)
Deprecated. Use the isFieldEditable(Field,Row,ExecutingContext,HttpServletRequest) method instead

Tests if the specified column of the table's contents can be updated directly from the table. (This method just checks to see if the table is okay with updating the specified column - that column may choose not to allow itself to be updated.)

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.

prepareActions

public void prepareActions(RowCollection rc,
                           ExecutingContext ec)
Creates the actions that will be generated with this table.

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.  

setCopyLinkText

public void setCopyLinkText(java.lang.String pCopyLinkText)
Sets text for copy button.

setCopyRCToTableLink

public void setCopyRCToTableLink(boolean newCopyRCToTableLink)
Creation date: (1/23/2002 4:52:01 PM)

Parameters:
newCopyRCToTableLink - boolean

setCopyURI

public void setCopyURI(java.lang.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(java.lang.String pDeleteAllLinkText)
Sets text for delete all button.

setDeleteLinkText

public void setDeleteLinkText(java.lang.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

setEditableFieldNames

public void setEditableFieldNames(java.util.List fieldNames)
Sets the names of the fields which this table allows to be edited. (Note that this method just checks to see if the table is okay with the fields being edited - the fields themselves may not allow updates).

setEditLinkText

public void setEditLinkText(java.lang.String pEditLinkText)
Sets text for edit button.

setEditURI

public void setEditURI(java.lang.String pEditURI)

setExcludedFieldNames

public void setExcludedFieldNames(java.util.List names)

setFieldNames

public void setFieldNames(java.util.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

setIncludeDataEngineJS

public void setIncludeDataEngineJS(boolean includeDataEngineJS)
Check if DataEngien JavaScript should be generated along with any HTML elements by this HTML table generator.

Parameters:
includeDataEngineJS - whether or not to include JavaScript for generated HTML elements.

setInsertable

public void setInsertable(boolean insertable)
Set table contents to allow or disallow inserting directly from the table.

setInsertLinkText

public void setInsertLinkText(java.lang.String pInsertLinkText)
Sets text for insert button.

setInsertURI

public void setInsertURI(java.lang.String pInsertURI)

setInternalPagingText

public void setInternalPagingText(java.lang.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(java.lang.String newNextPreviousJustify)

setNoRecordsFoundText

public void setNoRecordsFoundText(java.lang.String text)
Sets the text to display when there are no records

setPrintURI

public void setPrintURI(java.lang.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(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.

setProperties

public void setProperties(TableDisplayPropertyGroup pProperties)

setRowCollectionId

public void setRowCollectionId(java.lang.String rcId)

setRowId

public void setRowId(java.lang.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,
                                 HttpServletRequest request)
Sets the rows (RowCollection) to be used in populating the data for the table.

setRowSelectionJavascript

public void setRowSelectionJavascript(java.lang.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

setSelectedRows

public void setSelectedRows(java.util.List rows)
Sets the rows which should be rendered as already being selected

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(java.lang.String pStyleSheetLink)

setTableId

public void setTableId(java.lang.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

setTableWidth

public void setTableWidth(java.lang.String newTableWidth)
Sets the width of the table -
. The default is 0 (no table width attribute) !!A KGetting (12/05/2005)

setUpdateable

public void setUpdateable(boolean pUpdateable)
Sets if all of the table's contents can be updated directly from the table. (Note that this method just checks to see if the table is okay with the fields being updated - the fields themselves may not allow updates).

setUpdateableFieldNames

public void setUpdateableFieldNames(java.util.List fieldNames)
Deprecated. To avoid confusion this method has been renamed setEditableFieldNames

Sets the names of the fields which this table allows to be edited. (Note that this method just checks to see if the table is okay with the fields being edited - the fields themselves may not allow updates). A null List means everything can be edited; an empty List means nothing can be edited

setUpdateLinkText

public void setUpdateLinkText(java.lang.String pUpdateLinkText)
Sets text for update button.

setURI

public void setURI(java.lang.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(java.lang.String pViewLinkText)
Sets text for view button.

setViewURI

public void setViewURI(java.lang.String pViewURI)

setWrapHeaders

public void setWrapHeaders(boolean wrap)
Set whether or not column headers should be wrapped.

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD