planetj.html
Class HTMLRowDetails

java.lang.Object
  |
  +--planetj.html.HTMLElement
        |
        +--planetj.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

Constructor Summary

HTMLRowDetails()

Method Summary

StringBuffer	appendFieldSetCollectionDetails(FieldSetCollection fieldSetCollection, Row row, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generate HTML code for the given FieldSetCollection.
StringBuffer	appendFieldSetDetails(FieldSet fieldSet, Row row, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generate HTML code for the given FieldSetCollection.
String	generateDetails(FieldSetCollection fsc, Row row, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generate HTML code for the given FieldSetCollection.
String	generateDetails(FieldSet pFieldSet, Row pRow, boolean includeTags, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generates the details for a using only a field set.
String	generateDetails(FieldSet pFieldSet, Row pRow, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generates the details for a using only a field set.
String	generateDetails(Row row, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generates the details for a Row
int	getColumnCount() Gets the number of columns to use when displaying Row details.
List	getExcludedFieldNames()
List	getFieldNames()
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.
List	getRowDetailsFields(Row row, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generates the details for a Row
String	getStyleSheet() Deprecated. no longer used as of (5/28/2003 12:21:19 PM)
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	isLabelLeftJusified() Check whether or not the Field's label should be to the left of the Field being generated.
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(List names)
void	setFieldNames(List names)
void	setFieldSets(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	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(String styleSheet) Deprecated.
void	setUpdateable(boolean pUpdateable)

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

Constructor Detail

HTMLRowDetails

public HTMLRowDetails()

Method Detail

appendFieldSetCollectionDetails

public StringBuffer appendFieldSetCollectionDetails(FieldSetCollection fieldSetCollection,
                                                    Row row,
                                                    StringBuffer html,
                                                    javax.servlet.http.HttpServletRequest request,
                                                    javax.servlet.http.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

CMException

appendFieldSetDetails

public StringBuffer appendFieldSetDetails(FieldSet fieldSet,
                                          Row row,
                                          StringBuffer html,
                                          javax.servlet.http.HttpServletRequest request,
                                          javax.servlet.http.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

CMException

setDisplayEditFDs

public void setDisplayEditFDs(boolean newDisplayFDLink)

Sets if an FD link should be displayed next to the field

generateDetails

public String generateDetails(FieldSet pFieldSet,
                              Row pRow,
                              javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws CMException

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.

CMException

generateDetails

public String generateDetails(FieldSet pFieldSet,
                              Row pRow,
                              boolean includeTags,
                              javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws CMException

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.

CMException

generateDetails

public String generateDetails(FieldSetCollection fsc,
                              Row row,
                              javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.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

request - HttpServletRequest from client

response - HttpServletResponse to client

Returns:

String of generated HTML code for the given FieldSetCollection

CMException

generateDetails

public String generateDetails(Row row,
                              javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws CMException

Generates the details for a Row

CMException

getColumnCount

public final 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.

getExcludedFieldNames

public List getExcludedFieldNames()

getFieldNames

public List getFieldNames()

getFieldSets

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

getRowDetailsFields

public List getRowDetailsFields(Row row,
                                javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws CMException

Generates the details for a Row

CMException

getStyleSheet

public String getStyleSheet()

Deprecated. no longer used as of (5/28/2003 12:21:19 PM)

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.

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(List names)

setFieldNames

public void setFieldNames(List names)

setFieldSets

public void setFieldSets(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.

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(String styleSheet)

Deprecated.

setUpdateable

public void setUpdateable(boolean pUpdateable)