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 HTMLRowDetails

java.lang.Object
  extended byplanetj.html.HTMLElement
      extended byplanetj.html.HTMLRowDetails
public class HTMLRowDetails
extends HTMLElement

!!DA (8/6/2003 3:11:14 PM) documentation needed

Author:
PlanetJ Corporation

Field Summary
 
Fields inherited from class planetj.html.HTMLElement
DISABLED, FOCUS_HTML_INPUT
 
Constructor Summary
HTMLRowDetails()
           
 
Method Summary
 java.lang.StringBuffer appendFieldSetCollectionDetails(FieldSetCollection fieldSetCollection, Row row, java.lang.StringBuffer html, HttpServletRequest request, HttpServletResponse response)
          Generate HTML code for the given FieldSetCollection.
 java.lang.StringBuffer appendFieldSetDetails(FieldSet fieldSet, Row row, java.lang.StringBuffer html, HttpServletRequest request, HttpServletResponse response)
          Generate HTML code for the given FieldSetCollection.
 java.lang.String generateDetails(FieldSetCollection fsc, Row row, HttpServletRequest request, HttpServletResponse response)
          Deprecated. - replaced with appendFieldSetCollectionDetails(FieldSetCollection, Row, StringBuffer, HttpServletRequest, HttpServletResponse)
 java.lang.String generateDetails(FieldSet pFieldSet, Row pRow, boolean includeTags, HttpServletRequest request, HttpServletResponse response)
          Deprecated. - replaced with generateFieldSetDetails(FieldSet, Row, boolean, HttpServletRequest, HttpServletResponse)
 java.lang.String generateDetails(FieldSet pFieldSet, Row pRow, HttpServletRequest request, HttpServletResponse response)
          Deprecated. - replaced with generateFieldSetDetails(FieldSet, Row, boolean, HttpServletRequest, HttpServletResponse)
 java.lang.String generateDetails(Row row, HttpServletRequest request, HttpServletResponse response)
          Generates the details for a Row
 java.lang.String generateFieldSetDetails(FieldSet pFieldSet, Row pRow, boolean includeTags, HttpServletRequest request, HttpServletResponse response)
          Generates the details for using only a field set.
 int getColumnCount()
          Gets the number of columns to use when displaying Row details.
 int getColumnCount(FieldSet fs)
          Gets the number of columns to use when displaying Row details for a specific field set.
 java.util.List getExcludedFieldNames()
           
 java.util.List getFieldNames()
           
 java.util.List getFieldSets()
           
 int getMaxInputSize()
          Specifies a maximum width of an input field on the screen.
 int getMaxInputSizePerRow()
          Specifies the maximum sum of the width of all input fields on a row.
 java.util.List getRowDetailsFields(Row row, HttpServletRequest request, HttpServletResponse response)
          Generates the details for a Row
 java.lang.String getStyleSheet()
          Deprecated. no longer used as of (5/28/2003 12:21:19 PM)
 int getTableWidth()
          Specifies the width of the table - .
 boolean isCurrentTabParent(Row row, HttpServletRequest req)
          Tests if the specified row should be rendered as though it were the tab parent.
 boolean isDisplayEditFDs()
          Tests if an FD link should be displayed next to the field
 boolean isDisplayGrid()
          Check if grid should be shown.
 boolean isIncludeColonAfterLabel()
          Check whether or not to include a colon after the Field's label.
 boolean isIncludeDataEngineJS()
          Check if DataEngien JavaScript should be generated along with any HTML elements by this HTML table generator.
 boolean isLabelLeftJusified()
          Check whether or not the Field's label should be to the left of the Field being generated.
 boolean isSkipField(boolean isTabParent, Field field, HttpServletRequest req)
          Tests if the field should be skipped (not rendered on the screen)
 boolean isUpdateable()
           
 void setColumnCount(int newColumnCount)
          Sets the number of columns to use when displaying Row details.
 void setDisplayEditFDs(boolean newDisplayFDLink)
          Sets if an FD link should be displayed next to the field
 void setDisplayGrid(boolean displayGrid)
          Set whether or not to display a grid.
 void setExcludedFieldNames(java.util.List names)
           
 void setFieldNames(java.util.List names)
           
 void setFieldSets(java.util.List names)
          Set the list of fieldSets to use in HTML generation.
 void setIncludeColonAfterLabel(boolean includeColon)
          Set whether or not to include a colon after the Field's label.
 void setIncludeDataEngineJS(boolean includeDataEngineJS)
          Check if DataEngien JavaScript should be generated along with any HTML elements by this HTML table generator.
 void setLabelLeftJustified(boolean isLeftJustified)
          Set whether or not Field labels are displayed to the left of the Field.
 void setMaxInputSize(int newMaxInputSize)
          Sets the maximum width of an input field on the screen.
 void setMaxInputSizePerRow(int newMaxInputSizePerRow)
          Sets the maximum sum of the width of all input fields on a row.
 void setProperties(DetailDisplayPropertyGroup properties)
          Sets any display column 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 setStyleSheet(java.lang.String styleSheet)
          Deprecated.  
 void setTableWidth(int newTableWidth)
          Specifies the width of the table - .
 void setUpdateable(boolean pUpdateable)
           
 
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
 

Constructor Detail

HTMLRowDetails

public HTMLRowDetails()
Method Detail

isIncludeDataEngineJS

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

Returns:

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.

appendFieldSetCollectionDetails

public java.lang.StringBuffer appendFieldSetCollectionDetails(FieldSetCollection fieldSetCollection,
                                                              Row row,
                                                              java.lang.StringBuffer html,
                                                              HttpServletRequest request,
                                                              HttpServletResponse response)
                                                       throws CMException
Generate HTML code for the given FieldSetCollection. Details will be generated for each Field of the Row that is part of any FieldSet contained in the FieldSetCollection.

Parameters:
fieldSetCollection - collection of FieldSets to generate details for
row - Row containing Fields to generated details for
html - buffer to append HTML generated code to
request - HttpServletRequest from client
response - HttpServletResponse to client
Returns:
StringBuffer generated HTML code was appended to
Throws:
CMException

appendFieldSetDetails

public java.lang.StringBuffer appendFieldSetDetails(FieldSet fieldSet,
                                                    Row row,
                                                    java.lang.StringBuffer html,
                                                    HttpServletRequest request,
                                                    HttpServletResponse response)
                                             throws CMException
Generate HTML code for the given FieldSetCollection. Details will be generated for each Field of the Row that is part of any FieldSet contained in the FieldSetCollection.

Parameters:
row - Row containing Fields to generated details for
html - buffer to append HTML generated code to
request - HttpServletRequest from client
response - HttpServletResponse to client
Returns:
StringBuffer generated HTML code was appended to
Throws:
CMException

setDisplayEditFDs

public void setDisplayEditFDs(boolean newDisplayFDLink)
Sets if an FD link should be displayed next to the field

generateDetails

public final java.lang.String generateDetails(FieldSet pFieldSet,
                                              Row pRow,
                                              HttpServletRequest request,
                                              HttpServletResponse response)
                                       throws CMException
Deprecated. - replaced with generateFieldSetDetails(FieldSet, Row, boolean, HttpServletRequest, HttpServletResponse)

Generates the details for a using only a field set. This is more efficient than generateDetails(Row, HttpServletRequest, HttpServletResponse) when custom JSPs are making multiple calls to this method.

Throws:
CMException

generateDetails

public final java.lang.String generateDetails(FieldSet pFieldSet,
                                              Row pRow,
                                              boolean includeTags,
                                              HttpServletRequest request,
                                              HttpServletResponse response)
                                       throws CMException
Deprecated. - replaced with generateFieldSetDetails(FieldSet, Row, boolean, HttpServletRequest, HttpServletResponse)

Generates the details for using only a field set. This is more efficient than generateDetails(Row, HttpServletRequest, HttpServletResponse) when custom JSPs are making multiple calls to this method.

Throws:
CMException

generateFieldSetDetails

public final java.lang.String generateFieldSetDetails(FieldSet pFieldSet,
                                                      Row pRow,
                                                      boolean includeTags,
                                                      HttpServletRequest request,
                                                      HttpServletResponse response)
                                               throws CMException
Generates the details for using only a field set. This is more efficient than generateDetails(Row, HttpServletRequest, HttpServletResponse) when custom JSPs are making multiple calls to this method.

Throws:
CMException

generateDetails

public final java.lang.String generateDetails(FieldSetCollection fsc,
                                              Row row,
                                              HttpServletRequest request,
                                              HttpServletResponse response)
                                       throws CMException
Deprecated. - replaced with appendFieldSetCollectionDetails(FieldSetCollection, Row, StringBuffer, HttpServletRequest, HttpServletResponse)

Generate HTML code for the given FieldSetCollection. Details will be generated for each Field of the Row that is part of any FieldSet contained in the FieldSetCollection.

Parameters:
row - Row containing Fields to generated details for
request - HttpServletRequest from client
response - HttpServletResponse to client
Returns:
String of generated HTML code for the given FieldSetCollection
Throws:
CMException

generateDetails

public java.lang.String generateDetails(Row row,
                                        HttpServletRequest request,
                                        HttpServletResponse response)
                                 throws CMException
Generates the details for a Row

Throws:
CMException

getColumnCount

public int getColumnCount()
Gets the number of columns to use when displaying Row details. The details screen will try and put this many fields in a single row (if a field is very wide then its row may have fewer fields). If this value is less than one, the program will automatically choose the number of fields to place in each row.

getColumnCount

public int getColumnCount(FieldSet fs)
Gets the number of columns to use when displaying Row details for a specific field set. The details screen will try and put this many fields in a single row (if a field is very wide then its row may have fewer fields). If this value is less than one, the program will automatically choose the number of fields to place in each row.

getExcludedFieldNames

public java.util.List getExcludedFieldNames()

getFieldNames

public java.util.List getFieldNames()

getFieldSets

public java.util.List getFieldSets()
Returns:
Return a list of fieldsets to include in the generated HTML

getMaxInputSize

public final int getMaxInputSize()
Specifies a maximum width of an input field on the screen. This does not affect the maximum number of characters that can be entered in an input field, just the visible width. Certain display components, like TextAreas, are not affected by this value

getMaxInputSizePerRow

public final int getMaxInputSizePerRow()
Specifies the maximum sum of the width of all input fields on a row. If this is 80, then three input fields each with a width of 25 will fit on the same row. Three input fields with a width of 30 would have to be placed on two separate rows.

getTableWidth

public final int getTableWidth()
Specifies the width of the table - . The default is 0 (no table width attribute)

getRowDetailsFields

public java.util.List getRowDetailsFields(Row row,
                                          HttpServletRequest request,
                                          HttpServletResponse response)
                                   throws CMException
Generates the details for a Row

Throws:
CMException

getStyleSheet

public java.lang.String getStyleSheet()
Deprecated. no longer used as of (5/28/2003 12:21:19 PM)

isCurrentTabParent

public boolean isCurrentTabParent(Row row,
                                  HttpServletRequest req)
Tests if the specified row should be rendered as though it were the tab parent.

isDisplayEditFDs

public boolean isDisplayEditFDs()
Tests if an FD link should be displayed next to the field

isIncludeColonAfterLabel

public boolean isIncludeColonAfterLabel()
Check whether or not to include a colon after the Field's label.

isLabelLeftJusified

public boolean isLabelLeftJusified()
Check whether or not the Field's label should be to the left of the Field being generated.

isSkipField

public boolean isSkipField(boolean isTabParent,
                           Field field,
                           HttpServletRequest req)
                    throws CMException
Tests if the field should be skipped (not rendered on the screen)

Parameters:
isTabParent - Is the row being rendered the tab parent?
field - The field in question which may be skipped
Throws:
CMException

isUpdateable

public boolean isUpdateable()

isDisplayGrid

public boolean isDisplayGrid()
Check if grid should be shown.

setColumnCount

public void setColumnCount(int newColumnCount)
Sets the number of columns to use when displaying Row details. The details screen will try and put this many fields in a single row (if a field is very wide then its row may have fewer fields). If this value is less than one, the program will automatically choose the number of fields to place in each row.

setDisplayGrid

public void setDisplayGrid(boolean displayGrid)
Set whether or not to display a grid.

setExcludedFieldNames

public void setExcludedFieldNames(java.util.List names)

setFieldNames

public void setFieldNames(java.util.List names)

setFieldSets

public void setFieldSets(java.util.List names)
Set the list of fieldSets to use in HTML generation.

setIncludeColonAfterLabel

public void setIncludeColonAfterLabel(boolean includeColon)
Set whether or not to include a colon after the Field's label.

setLabelLeftJustified

public void setLabelLeftJustified(boolean isLeftJustified)
Set whether or not Field labels are displayed to the left of the Field.

Parameters:
isLeftJustified - true to display labels to the left; otherwise false which displays them above the Fields

setMaxInputSize

public void setMaxInputSize(int newMaxInputSize)
Sets the maximum width of an input field on the screen. This does not affect the maximum number of characters that can be entered in an input field, just the visible width. Certain display components, like TextAreas, are not affected by this value

setMaxInputSizePerRow

public void setMaxInputSizePerRow(int newMaxInputSizePerRow)
Sets the maximum sum of the width of all input fields on a row. If this is 80, then three input fields each with a width of 25 will fit on the same row. Three input fields with a width of 30 would have to be placed on two separate rows.

setTableWidth

public void setTableWidth(int newTableWidth)
Specifies the width of the table -
. The default is 0 (no table width attribute)

setProperties

public void setProperties(DetailDisplayPropertyGroup properties)
Sets any display column properties for this HTML table.

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.

setStyleSheet

public void setStyleSheet(java.lang.String styleSheet)
Deprecated.  

setUpdateable

public void setUpdateable(boolean pUpdateable)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD