net.mlw.vlh.web.tag.support
Interface DisplayProvider

All Known Implementing Classes:

AbstractHTMLDisplayProvider, CsvDisplayProvider, ExcelDisplayProvider

public interface DisplayProvider

This interface defines how the valuelist should be rendered.

Author:

mwilson TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

Method Summary

boolean	doesIncludeBodyContent()
String	emphase(String text, String emphasisPattern, String style) Get the HTML that emphase text.
String	getCellPostProcess()
String	getCellPreProcess(Attributes attributes)
String	getHeaderCellPostProcess() Get the HTML that comes after the column text.
String	getHeaderCellPreProcess(ColumnInfo columnInfo, ValueListInfo info) Get the HTML that comes before the column text.
String	getHeaderLabel(ColumnInfo columnInfo, TableInfo tableInfo, ValueListInfo info, Map includeParameters) Formats the text to be displayed as the header by waraping it in a link if sorting is enabled.
String	getHeaderRowPostProcess() Get the HTML that comes before the column text.
String	getHeaderRowPreProcess() Get the HTML that comes before the column text.
String	getMimeType()
String	getNestedHeaderPostProcess()
String	getNestedHeaderPreProcess(ColumnInfo columnInfo, ValueListInfo info)
String	getRowPostProcess()
String	getRowPreProcess(Attributes attributes)

Method Detail

doesIncludeBodyContent

public boolean doesIncludeBodyContent()

getMimeType

public String getMimeType()

getHeaderRowPreProcess

public String getHeaderRowPreProcess()

Get the HTML that comes before the column text.

Returns:

The HTML that comes before the column text.

getHeaderCellPreProcess

public String getHeaderCellPreProcess(ColumnInfo columnInfo,
                                      ValueListInfo info)

Get the HTML that comes before the column text.

Returns:

The HTML that comes before the column text.

getHeaderLabel

public String getHeaderLabel(ColumnInfo columnInfo,
                             TableInfo tableInfo,
                             ValueListInfo info,
                             Map includeParameters)

Formats the text to be displayed as the header by waraping it in a link if sorting is enabled.

Parameters:

columnInfo - The ColumnInfo.

tableInfo - The TableInfo.

info - The ValueListInfo.

Returns:

The formated HTML.

getHeaderCellPostProcess

public String getHeaderCellPostProcess()

Get the HTML that comes after the column text.

Returns:

The HTML that comes after the column text.

getHeaderRowPostProcess

public String getHeaderRowPostProcess()

Get the HTML that comes before the column text.

Returns:

The HTML that comes before the column text.

getRowPreProcess

public String getRowPreProcess(Attributes attributes)

getCellPreProcess

public String getCellPreProcess(Attributes attributes)

getCellPostProcess

public String getCellPostProcess()

getRowPostProcess

public String getRowPostProcess()

emphase

public String emphase(String text,
                      String emphasisPattern,
                      String style)

Get the HTML that emphase text.

Parameters:

style - CSS className for the span tag.

text - a String that represent source text to search the emphasis pattern.

emphasisPattern - a String that will be emphased in text.

Returns:

String Text with emphasised pattern.

getNestedHeaderPreProcess

public String getNestedHeaderPreProcess(ColumnInfo columnInfo,
                                        ValueListInfo info)

getNestedHeaderPostProcess

public String getNestedHeaderPostProcess()