IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.struts.taglib.html
Class DSETableTagSupport

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended bycom.ibm.btt.struts.taglib.html.StrutsTagSupport
          extended bycom.ibm.btt.struts.taglib.html.DSETableTagSupport
All Implemented Interfaces:
javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
TableTag

public abstract class DSETableTagSupport
extends StrutsTagSupport

This class implements the DSETableTagSupport that provides basic support for JSP Tag that create tables.

The following tag attributes can be associated with the DSETableSupportTag:

Subclasses of DSETableTagSupport create an HTML Table element that shows the contents of IndexedCollections.

See Also:
Serialized Form

Field Summary
protected  java.lang.String border
          The HMTL table element attribute: border
protected static java.lang.String CA_CA
          The HTML TD element attribute: class
protected static java.lang.String CA_TA
          The HTML TD element attribute: align
protected static java.lang.String CA_WA
          The HTML TD element attribute: width
protected  java.lang.String cellBGColor
          The HTML table cell background color
protected  java.lang.String cellBGColor2
          The HTML table cell second background color to alternate the colors
protected  java.lang.String cellpadding
          The HMTL table element attribute: cellpadding
protected  java.lang.String cellspacing
          The HMTL table element attribute: cellspacing
protected  java.lang.String colAlignments
          The HTML table columns text aligment
protected  java.lang.String colSizes
          The HTML table columns size
protected static java.lang.String CT_CLOSE
          The HTML caption element close
protected static java.lang.String CT_OPEN
          The HTML caption element open
protected  java.lang.String dataNameForList
          The IndexedCollection or KeyedCollection name
protected  int end
          The end indicator of the indexed collection
protected  java.lang.String headerAlignment
          The HTML table headers text aligment
protected  java.lang.String headerBGColor
          The HTML table headers background color
protected  java.lang.String headerFontColor
          The HTML table headers font color
protected  java.lang.String headerFontFace
          The HTML table headers font face
protected  java.lang.String headerFontSize
          The HTML table headers font size
protected  java.lang.String headers
          The HTML table headers
protected  IndexedCollection ic
           
protected  java.lang.String showCaption
          The indicator to insert the HMTL caption element or not
protected  java.lang.String showHeaders
          The indicator to insert the HMTL table headers or not
protected  java.lang.String skipCols
          The number of column to skip
protected  int start
          The start indicator of the indexed collection
protected static java.lang.String TB_TA
          The HTML table element attribute: border
protected static java.lang.String TBG_TA
          The HTML TR element attribute: bgcolor
protected static java.lang.String TCP_TA
          The HTML table element attribute: cellpadding
protected static java.lang.String TCS_TA
          The HTML table element attribute: cellspacing
protected static java.lang.String TDT_CLOSE
          The HTML TD element close
protected static java.lang.String TDT_OPEN
          The HTML TD element open
protected static java.lang.String THT_CLOSE
          The HTML TH element close
protected static java.lang.String THT_OPEN
          The HTML TH element open
protected static java.lang.String TRT_CLOSE
          The HTML TR element close
protected static java.lang.String TRT_OPEN
          The HTML TR element open
protected static java.lang.String TT_CLOSE
          The HTML table element close
protected static java.lang.String TT_OPEN
          The HTML table element open
protected static java.lang.String TW_TA
          The HTML table element attribute: width
protected  java.lang.String width
          The HMTL table element attribute: width
 
Fields inherited from class com.ibm.btt.struts.taglib.html.StrutsTagSupport
APPLICATION_SCOPE, BR_RE, BT_CLOSE, BT_OPEN, buffer, BUTTON, CENTER, COMMENT_VAL_ERROR, COMPID, custom, dataName, DOC_CLOSE, DOC_FORM_EVENT, DOC_FORM_HALF1, DOC_FORM_HALF2, DOC_SUBMIT, DOT, ERRORCOLOR, FCLTA, FCTA, FFTA, fontColor, fontFace, fontSize, FSTA, FT_CLOSE, FT_OPEN, HARD, IBT_OPEN, ICKT_OPEN, IHT_OPEN, IIT_OPEN, IMAGE, IPT_OPEN, IRAT_OPEN, IRT_OPEN, IST_OPEN, IT_CA, IT_CHECKED, IT_DISA, IT_MA, IT_NA, IT_OA, IT_OPEN, IT_READ, IT_READONLY, IT_SA, IT_SRA, IT_VA, IT_WA, ITT_OPEN, LEFT, LO_RE, LOWT, msgPrefix, name, NBSP, NO, NULL, OFF, out, PAGE_SCOPE, QU_LO, QU_LO_RE, QU_SP, QUOT, REQUEST_SCOPE, RESET, RET, RIGHT, SESSION_SCOPE, SOFT, SP, styleName, SUBMIT, TAT_CA, TAT_CLOSE, TAT_OPNE, TAT_RA, TAT_WA, utb, valErrBundle, YES
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
DSETableTagSupport()
          Default constructor.
 
Method Summary
 void bufferAppendHeaderFontEnd()
          Appends the end font tag to the buffer.
 void bufferAppendHeaderFontStart()
          Appends the start font tag to the buffer.
 void bufferAppendHeaders(KeyedCollection aKeyedCollection)
          Creates the Table headers using the ids of the DataElements contained in aKeyedCollection.
 void bufferAppendHeaders(java.util.StringTokenizer tokenizer)
          Creates the Table headers when they have been defined in the headers attribute.
 void bufferAppendTDOpen(java.lang.String[] align, java.lang.String[] size, int col)
          Appends the start font tag to the buffer.
 void bufferAppendTROpen(int row)
          Appends the start font tag to the buffer.
abstract  void doForIndexedCollection()
          Processes when the IndexedCollection specified by the dataNameForList property contains IndexedCollections.
abstract  void doForKeyedCollection()
          Processes when the IndexedCollection specified by the dataNameForList property contains KeyedCollections.
 int doStartTag()
          Processes the start tag for this instance.
 java.lang.String[] getColAligns()
          Returns the value of the colAlignments property in a String[] object.
 java.lang.String[] getColWidths()
          Returns the value of the colSizes property in a String[] object.
 java.lang.String getStringValue(DataElement aDataElement)
          Returns the value of the aDataElement property.
 void setBorder(java.lang.String newBorder)
          Sets the border property with a new value.
 void setCellBGColor(java.lang.String newCellBGColor)
          Sets the cellBGColor property with a new value.
 void setCellBGColor2(java.lang.String newCellBGColor2)
          Sets the cellBGColor2 property with a new value.
 void setCellpadding(java.lang.String newCellpadding)
          Sets the cellpadding property with a new value.
 void setCellspacing(java.lang.String newCellspacing)
          Sets the cellspacing property with a new value.
 void setColAlignments(java.lang.String newColAlignments)
          Sets the colAlignments property with a new value.
 void setColSizes(java.lang.String newColSizes)
          Sets the colSizes property with a new value.
 void setDataNameForList(java.lang.String newDataNameForList)
          Sets the dataNameForList property with a new value.
 void setEnd(java.lang.String newEnd)
          Sets the end property with a new value.
 void setHeaderAlignment(java.lang.String newHeaderAlignment)
          Sets the headerAlignment property with a new value.
 void setHeaderBGColor(java.lang.String newHeaderBGColor)
          Sets the headerBGColor property with a new value.
 void setHeaderFontColor(java.lang.String newHeaderFontColor)
          Sets the HeaderFontColor property with a new value
 void setHeaderFontFace(java.lang.String newHeaderFontFace)
          Sets the headerFontFace property with a new value.
 void setHeaderFontSize(java.lang.String newHeaderFontSize)
          Sets the headerFontSize property with a new value.
 void setHeaders(java.lang.String newHeaders)
          Sets the headers property with a new value.
 void setShowCaption(java.lang.String newShowCaption)
          Sets the showCaption property with a new value.
 void setShowHeaders(java.lang.String newShowHeaders)
          Sets the showHeaders property with a new value.
 void setSkipCols(java.lang.String newSkipCols)
          Sets the skipCols property with a new value.
 void setStart(java.lang.String newStart)
          Sets the start property with a new value.
 void setWidth(java.lang.String newWidth)
          Sets the width property with a new value.
 
Methods inherited from class com.ibm.btt.struts.taglib.html.StrutsTagSupport
bufferAppendFontEnd, bufferAppendFontStart, getJspContextServices, getName, getResourceBundle, setCustom, setDataName, setFontColor, setFontFace, setFontSize, setName, setPageContext, setResourceBundle, setResourceBundle, setStyle, setVEResourceBundle
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ic

protected IndexedCollection ic

dataNameForList

protected java.lang.String dataNameForList
The IndexedCollection or KeyedCollection name


border

protected java.lang.String border
The HMTL table element attribute: border


cellspacing

protected java.lang.String cellspacing
The HMTL table element attribute: cellspacing


cellpadding

protected java.lang.String cellpadding
The HMTL table element attribute: cellpadding


width

protected java.lang.String width
The HMTL table element attribute: width


start

protected int start
The start indicator of the indexed collection


end

protected int end
The end indicator of the indexed collection


showCaption

protected java.lang.String showCaption
The indicator to insert the HMTL caption element or not


showHeaders

protected java.lang.String showHeaders
The indicator to insert the HMTL table headers or not


headers

protected java.lang.String headers
The HTML table headers


headerFontFace

protected java.lang.String headerFontFace
The HTML table headers font face


headerFontSize

protected java.lang.String headerFontSize
The HTML table headers font size


headerFontColor

protected java.lang.String headerFontColor
The HTML table headers font color


headerAlignment

protected java.lang.String headerAlignment
The HTML table headers text aligment


headerBGColor

protected java.lang.String headerBGColor
The HTML table headers background color


cellBGColor

protected java.lang.String cellBGColor
The HTML table cell background color


cellBGColor2

protected java.lang.String cellBGColor2
The HTML table cell second background color to alternate the colors


colSizes

protected java.lang.String colSizes
The HTML table columns size


colAlignments

protected java.lang.String colAlignments
The HTML table columns text aligment


skipCols

protected java.lang.String skipCols
The number of column to skip


CT_OPEN

protected static final java.lang.String CT_OPEN
The HTML caption element open

See Also:
Constant Field Values

CT_CLOSE

protected static final java.lang.String CT_CLOSE
The HTML caption element close

See Also:
Constant Field Values

TT_OPEN

protected static final java.lang.String TT_OPEN
The HTML table element open

See Also:
Constant Field Values

TB_TA

protected static final java.lang.String TB_TA
The HTML table element attribute: border

See Also:
Constant Field Values

TW_TA

protected static final java.lang.String TW_TA
The HTML table element attribute: width

See Also:
Constant Field Values

TCS_TA

protected static final java.lang.String TCS_TA
The HTML table element attribute: cellspacing

See Also:
Constant Field Values

TCP_TA

protected static final java.lang.String TCP_TA
The HTML table element attribute: cellpadding

See Also:
Constant Field Values

TT_CLOSE

protected static final java.lang.String TT_CLOSE
The HTML table element close

See Also:
Constant Field Values

TRT_OPEN

protected static final java.lang.String TRT_OPEN
The HTML TR element open

See Also:
Constant Field Values

TBG_TA

protected static final java.lang.String TBG_TA
The HTML TR element attribute: bgcolor

See Also:
Constant Field Values

TRT_CLOSE

protected static final java.lang.String TRT_CLOSE
The HTML TR element close

See Also:
Constant Field Values

THT_OPEN

protected static final java.lang.String THT_OPEN
The HTML TH element open

See Also:
Constant Field Values

THT_CLOSE

protected static final java.lang.String THT_CLOSE
The HTML TH element close

See Also:
Constant Field Values

TDT_OPEN

protected static final java.lang.String TDT_OPEN
The HTML TD element open

See Also:
Constant Field Values

TDT_CLOSE

protected static final java.lang.String TDT_CLOSE
The HTML TD element close

See Also:
Constant Field Values

CA_TA

protected static final java.lang.String CA_TA
The HTML TD element attribute: align

See Also:
Constant Field Values

CA_CA

protected static final java.lang.String CA_CA
The HTML TD element attribute: class

See Also:
Constant Field Values

CA_WA

protected static final java.lang.String CA_WA
The HTML TD element attribute: width

See Also:
Constant Field Values
Constructor Detail

DSETableTagSupport

public DSETableTagSupport()
Default constructor. This constructor is called by the code generated by the JSP translator.

Method Detail

bufferAppendHeaderFontEnd

public void bufferAppendHeaderFontEnd()
Appends the end font tag to the buffer.


bufferAppendHeaderFontStart

public void bufferAppendHeaderFontStart()
Appends the start font tag to the buffer.


bufferAppendHeaders

public void bufferAppendHeaders(java.util.StringTokenizer tokenizer)
Creates the Table headers when they have been defined in the headers attribute.

Parameters:
tokenizer - The headers contents

bufferAppendHeaders

public void bufferAppendHeaders(KeyedCollection aKeyedCollection)
                         throws DSEObjectNotFoundException
Creates the Table headers using the ids of the DataElements contained in aKeyedCollection.

Parameters:
aKeyedCollection - The keyed collection
Throws:
com.ibm.dse.base.DSEObjectNotFound
DSEObjectNotFoundException

bufferAppendTDOpen

public void bufferAppendTDOpen(java.lang.String[] align,
                               java.lang.String[] size,
                               int col)
Appends the start font tag to the buffer.

Parameters:
align - The align attribute
size - The size attribute
col - the column number

bufferAppendTROpen

public void bufferAppendTROpen(int row)
Appends the start font tag to the buffer.

Parameters:
row - The row number

doForIndexedCollection

public abstract void doForIndexedCollection()
                                     throws java.io.IOException,
                                            DSEObjectNotFoundException,
                                            DSETypeException
Processes when the IndexedCollection specified by the dataNameForList property contains IndexedCollections.

Throws:
java.io.IOException
DSEObjectNotFound
DSETypeException
DSEObjectNotFoundException

doForKeyedCollection

public abstract void doForKeyedCollection()
                                   throws java.io.IOException,
                                          DSEObjectNotFoundException,
                                          DSETypeException
Processes when the IndexedCollection specified by the dataNameForList property contains KeyedCollections.

Throws:
java.io.IOException
DSEObjectNotFound
DSETypeException
DSEObjectNotFoundException

doStartTag

public int doStartTag()
Processes the start tag for this instance. This method is invoked by the JSP page implementation object. The doStartTag method assumes that the properties pageContext and parent have been set. It also assumes that any properties exposed as attributes have been set. When this method is invoked, the body has not yet been evaluated.

This method returns Tag.EVAL_BODY_INCLUDE or BodyTag.EVAL_BODY_BUFFERED to indicate that the body of the action should be evaluated or SKIP_BODY to indicate otherwise. When a Tag returns EVAL_BODY_INCLUDE, this method includes the result of evaluating the body (if any) in the current "out" JspWriter and then invokes doEndTag().

Refer to the class description for specific details about this method.

Returns:
int - The evaluation constant

getColAligns

public java.lang.String[] getColAligns()
Returns the value of the colAlignments property in a String[] object.

Returns:
java.lang.String[] - The value

getColWidths

public java.lang.String[] getColWidths()
Returns the value of the colSizes property in a String[] object.

Returns:
java.lang.String[] - The value

getStringValue

public java.lang.String getStringValue(DataElement aDataElement)
                                throws DSETypeException
Returns the value of the aDataElement property.

Returns:
java.lang.String - The value
Throws:
DSETypeException

setBorder

public void setBorder(java.lang.String newBorder)
Sets the border property with a new value.

Parameters:
newBorder - The new value

setCellBGColor

public void setCellBGColor(java.lang.String newCellBGColor)
Sets the cellBGColor property with a new value.

Parameters:
newCellBGColor - The new value

setCellBGColor2

public void setCellBGColor2(java.lang.String newCellBGColor2)
Sets the cellBGColor2 property with a new value.

Parameters:
newCellBGColor2 - The new value

setCellpadding

public void setCellpadding(java.lang.String newCellpadding)
Sets the cellpadding property with a new value.

Parameters:
newCellpadding - The new value

setCellspacing

public void setCellspacing(java.lang.String newCellspacing)
Sets the cellspacing property with a new value.

Parameters:
newCellspacing - The new value

setColAlignments

public void setColAlignments(java.lang.String newColAlignments)
Sets the colAlignments property with a new value.

Parameters:
newColAlignments - The new value

setColSizes

public void setColSizes(java.lang.String newColSizes)
Sets the colSizes property with a new value.

Parameters:
newColSizes - The new value

setDataNameForList

public void setDataNameForList(java.lang.String newDataNameForList)
Sets the dataNameForList property with a new value.

Parameters:
newDataNameForList - The new value

setEnd

public void setEnd(java.lang.String newEnd)
Sets the end property with a new value.

Parameters:
newEnd - The new value

setHeaderAlignment

public void setHeaderAlignment(java.lang.String newHeaderAlignment)
Sets the headerAlignment property with a new value.

Parameters:
newHeaderAlignment - The new value

setHeaderBGColor

public void setHeaderBGColor(java.lang.String newHeaderBGColor)
Sets the headerBGColor property with a new value.

Parameters:
newHeaderBGColor - The new value

setHeaderFontColor

public void setHeaderFontColor(java.lang.String newHeaderFontColor)
Sets the HeaderFontColor property with a new value

Parameters:
newHeaderFontColor - The new value

setHeaderFontFace

public void setHeaderFontFace(java.lang.String newHeaderFontFace)
Sets the headerFontFace property with a new value.

Parameters:
newHeaderFontFace - The new value

setHeaderFontSize

public void setHeaderFontSize(java.lang.String newHeaderFontSize)
Sets the headerFontSize property with a new value.

Parameters:
newHeaderFontSize - The new value

setHeaders

public void setHeaders(java.lang.String newHeaders)
Sets the headers property with a new value.

Parameters:
newHeaders - The new value

setShowCaption

public void setShowCaption(java.lang.String newShowCaption)
Sets the showCaption property with a new value.

Parameters:
newShowCaption - The new value

setShowHeaders

public void setShowHeaders(java.lang.String newShowHeaders)
Sets the showHeaders property with a new value.

Parameters:
newShowHeaders - The new value

setSkipCols

public void setSkipCols(java.lang.String newSkipCols)
Sets the skipCols property with a new value.

Parameters:
newSkipCols - The new value

setStart

public void setStart(java.lang.String newStart)
Sets the start property with a new value.

Parameters:
newStart - The new value

setWidth

public void setWidth(java.lang.String newWidth)
Sets the width property with a new value.

Parameters:
newWidth - The new value

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005