|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.displaytag.render.TableWriterTemplate
org.displaytag.render.TableWriterAdapter
public abstract class TableWriterAdapter
Convenience abstract adapter for constructing a table view; contains only stub implementations. This class exists as a convenience for creating table-writer objects. Extend this class to create a table writer and override the methods of interest. This class also protects subclasses from future additions to TableWriterTemplate they may not be interested in.
| Field Summary |
|---|
| Fields inherited from class org.displaytag.render.TableWriterTemplate |
|---|
GROUP_END, GROUP_NO_CHANGE, GROUP_START, GROUP_START_AND_END, NO_RESET_GROUP |
| Constructor Summary | |
|---|---|
TableWriterAdapter()
|
|
| Method Summary | |
|---|---|
protected void |
writeBottomBanner(TableModel model)
Called by writeTable to write the table's footer. |
protected void |
writeCaption(TableModel model)
Called by writeTable to write the table's caption. |
protected void |
writeColumnCloser(Column column)
Called by writeTableBody to write the end of the column structure. |
protected void |
writeColumnOpener(Column column)
Called by writeTableBody to write the start of the column structure. |
protected void |
writeColumnValue(java.lang.Object value,
Column column)
Called by writeTableBody to write a column's value. |
protected void |
writeDecoratedRowFinish(TableModel model)
Called by writeTableBody to decorate the table. |
protected void |
writeDecoratedRowStart(TableModel model)
Called by writeTableBody to write to decorate the table. |
protected void |
writeDecoratedTableFinish(TableModel model)
Called by writeTable to decorate the table. |
protected void |
writeEmptyListMessage(java.lang.String emptyListMessage)
Called by writeTable to write a message explaining that the table model contains no data. |
protected void |
writeEmptyListRowMessage(java.lang.String message)
Called by writeTableBody to write a message explaining that the row contains no data. |
protected void |
writePostBodyFooter(TableModel model)
Called by writeTable to write table footer after table body. |
protected void |
writePreBodyFooter(TableModel model)
Called by writeTable to write table footer before table body. |
protected void |
writeRowCloser(Row row)
Called by writeTableBody to write the end of the row structure. |
protected void |
writeRowOpener(Row row)
Called by writeTableBody to write the start of the row structure. |
protected void |
writeRowWithNoColumns(java.lang.String string)
Called by writeTableBody to write a row that has no columns. |
protected void |
writeTableBodyCloser(TableModel model)
Called by writeTable to write the end of the table's body. |
protected void |
writeTableBodyOpener(TableModel model)
Called by writeTable to write the start of the table's body. |
protected void |
writeTableCloser(TableModel model)
Called by writeTable to write the end of the table's structure. |
protected void |
writeTableHeader(TableModel model)
Called by writeTable to write the table's header columns. |
protected void |
writeTableOpener(TableModel model)
Called by writeTable to write the start of the table structure. |
protected void |
writeTopBanner(TableModel model)
Called by writeTable to write a summary of the search result this table reports and the table's pagination interface. |
| Methods inherited from class org.displaytag.render.TableWriterTemplate |
|---|
groupColumns, writeTable |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public TableWriterAdapter()
| Method Detail |
|---|
protected void writeEmptyListMessage(java.lang.String emptyListMessage)
throws java.lang.Exception
TableWriterTemplate
writeEmptyListMessage in class TableWriterTemplateemptyListMessage - A message explaining that the table model contains no data.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeEmptyListMessage(java.lang.String)
protected void writeTopBanner(TableModel model)
throws java.lang.Exception
TableWriterTemplate
writeTopBanner in class TableWriterTemplatemodel - The table model for which the banner is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeTopBanner(org.displaytag.model.TableModel)
protected void writeTableOpener(TableModel model)
throws java.lang.Exception
TableWriterTemplate
writeTableOpener in class TableWriterTemplatemodel - The table model for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeTableOpener(org.displaytag.model.TableModel)
protected void writeCaption(TableModel model)
throws java.lang.Exception
TableWriterTemplate
writeCaption in class TableWriterTemplatemodel - The table model for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeCaption(org.displaytag.model.TableModel)
protected void writeTableHeader(TableModel model)
throws java.lang.Exception
TableWriterTemplate
writeTableHeader in class TableWriterTemplatemodel - The table model for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeTableHeader(org.displaytag.model.TableModel)
protected void writePreBodyFooter(TableModel model)
throws java.lang.Exception
TableWriterTemplate
writePreBodyFooter in class TableWriterTemplatemodel - The table model for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writePreBodyFooter(org.displaytag.model.TableModel)
protected void writeTableBodyOpener(TableModel model)
throws java.lang.Exception
TableWriterTemplate
writeTableBodyOpener in class TableWriterTemplatemodel - The table model for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeTableBodyOpener(org.displaytag.model.TableModel)
protected void writeTableBodyCloser(TableModel model)
throws java.lang.Exception
TableWriterTemplate
writeTableBodyCloser in class TableWriterTemplatemodel - The table model for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeTableBodyCloser(org.displaytag.model.TableModel)
protected void writePostBodyFooter(TableModel model)
throws java.lang.Exception
TableWriterTemplate
writePostBodyFooter in class TableWriterTemplatemodel - The table model for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writePostBodyFooter(org.displaytag.model.TableModel)
protected void writeTableCloser(TableModel model)
throws java.lang.Exception
TableWriterTemplate
writeTableCloser in class TableWriterTemplatemodel - The table model for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeTableCloser(org.displaytag.model.TableModel)
protected void writeBottomBanner(TableModel model)
throws java.lang.Exception
TableWriterTemplate
writeBottomBanner in class TableWriterTemplatemodel - The table model for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeBottomBanner(org.displaytag.model.TableModel)
protected void writeDecoratedTableFinish(TableModel model)
throws java.lang.Exception
TableWriterTemplate
writeDecoratedTableFinish in class TableWriterTemplatemodel - The table model for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeDecoratedTableFinish(org.displaytag.model.TableModel)
protected void writeDecoratedRowStart(TableModel model)
throws java.lang.Exception
TableWriterTemplate
writeDecoratedRowStart in class TableWriterTemplatemodel - The table model for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeDecoratedRowStart(org.displaytag.model.TableModel)
protected void writeRowOpener(Row row)
throws java.lang.Exception
TableWriterTemplate
writeRowOpener in class TableWriterTemplaterow - The table row for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeRowOpener(org.displaytag.model.Row)
protected void writeColumnOpener(Column column)
throws java.lang.Exception
TableWriterTemplate
writeColumnOpener in class TableWriterTemplatecolumn - The table column for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeColumnOpener(org.displaytag.model.Column)
protected void writeColumnValue(java.lang.Object value,
Column column)
throws java.lang.Exception
TableWriterTemplate
writeColumnValue in class TableWriterTemplatevalue - The column value.column - The table column for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeColumnValue(Object,org.displaytag.model.Column)
protected void writeColumnCloser(Column column)
throws java.lang.Exception
TableWriterTemplate
writeColumnCloser in class TableWriterTemplatecolumn - The table column for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeColumnCloser(org.displaytag.model.Column)
protected void writeRowWithNoColumns(java.lang.String string)
throws java.lang.Exception
TableWriterTemplate
writeRowWithNoColumns in class TableWriterTemplatestring - The row value.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeRowWithNoColumns(java.lang.String)
protected void writeRowCloser(Row row)
throws java.lang.Exception
TableWriterTemplate
writeRowCloser in class TableWriterTemplaterow - The table row for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeRowCloser(org.displaytag.model.Row)
protected void writeDecoratedRowFinish(TableModel model)
throws java.lang.Exception
TableWriterTemplate
writeDecoratedRowFinish in class TableWriterTemplatemodel - The table model for which the content is written.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeDecoratedRowFinish(org.displaytag.model.TableModel)
protected void writeEmptyListRowMessage(java.lang.String message)
throws java.lang.Exception
TableWriterTemplate
writeEmptyListRowMessage in class TableWriterTemplatemessage - The message explaining that the row contains no data.
java.lang.Exception - if it encounters an error while writing.TableWriterTemplate.writeEmptyListRowMessage(java.lang.String)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||