org.myire.quill.dashboard

Class DashboardLayout

java.lang.Object

org.myire.quill.dashboard.DashboardLayout

public class DashboardLayout
extends java.lang.Object

The layout of the dashboard sections matrix. The sections are logically output as a matrix where the number of columns can be configured. The HTML code that starts and ends the entire matrix, each row and each cell can also be configured.

All HTML code properties can be specified as either strings or closures returning strings.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCellEndHtmlCode() Get the HTML code to end each section cell in the matrix with.
java.lang.String	getCellStartHtmlCode() Get the HTML code to start each section cell in the matrix with.
java.io.File	getFooterHtmlFile() Get the HTML file that will be put after the sections in the report file.
java.io.File	getHeaderHtmlFile() Get the HTML file that will be put before the sections in the report file.
java.lang.String	getHeadlineHtmlCode() Get the HTML code for the headline to display before the matrix with all sections.
int	getNumColumns() Get the number of columns to present the sections in.
java.lang.String	getRowEndHtmlCode() Get the HTML code to end each row of sections with.
java.lang.String	getRowStartHtmlCode() Get the HTML code to start each row of sections with.
java.lang.String	getSectionsEndHtmlCode() Get the HTML code to end the sections matrix with.
java.lang.String	getSectionsStartHtmlCode() Get the HTML code to start the sections matrix with.
void	setCellEndHtmlCode(java.lang.Object pCode)
void	setCellStartHtmlCode(java.lang.Object pCode)
void	setFooterHtmlFile(java.lang.Object pFile)
void	setHeaderHtmlFile(java.lang.Object pFile)
void	setHeadlineHtmlCode(java.lang.Object pCode)
void	setNumColumns(int pNumColumns)
void	setRowEndHtmlCode(java.lang.Object pCode)
void	setRowStartHtmlCode(java.lang.Object pCode)
void	setSectionsEndHtmlCode(java.lang.Object pCode)
void	setSectionsStartHtmlCode(java.lang.Object pCode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getHeaderHtmlFile

@InputFile
 @Optional
public java.io.File getHeaderHtmlFile()

Get the HTML file that will be put before the sections in the report file. If this file is not specified, a default header will be used.

Returns:

The header HTML file to use, possibly null.

setHeaderHtmlFile

public void setHeaderHtmlFile(java.lang.Object pFile)

getFooterHtmlFile

@InputFile
 @Optional
public java.io.File getFooterHtmlFile()

Get the HTML file that will be put after the sections in the report file. If this file is not specified, a default footer will be used.

Returns:

The footer HTML file to use, possibly null.

setFooterHtmlFile

public void setFooterHtmlFile(java.lang.Object pFile)

getHeadlineHtmlCode

@Input
public java.lang.String getHeadlineHtmlCode()

Get the HTML code for the headline to display before the matrix with all sections.

Returns:

The headline HTML code.

setHeadlineHtmlCode

public void setHeadlineHtmlCode(java.lang.Object pCode)

getSectionsStartHtmlCode

@Input
public java.lang.String getSectionsStartHtmlCode()

Get the HTML code to start the sections matrix with.

Returns:

The sections matrix start HTML code.

setSectionsStartHtmlCode

public void setSectionsStartHtmlCode(java.lang.Object pCode)

getSectionsEndHtmlCode

@Input
public java.lang.String getSectionsEndHtmlCode()

Get the HTML code to end the sections matrix with.

Returns:

The sections matrix end HTML code.

setSectionsEndHtmlCode

public void setSectionsEndHtmlCode(java.lang.Object pCode)

getRowStartHtmlCode

@Input
public java.lang.String getRowStartHtmlCode()

Get the HTML code to start each row of sections with.

Returns:

The section row start HTML code.

setRowStartHtmlCode

public void setRowStartHtmlCode(java.lang.Object pCode)

getRowEndHtmlCode

@Input
public java.lang.String getRowEndHtmlCode()

Get the HTML code to end each row of sections with.

Returns:

The section row end HTML code.

setRowEndHtmlCode

public void setRowEndHtmlCode(java.lang.Object pCode)

getCellStartHtmlCode

@Input
public java.lang.String getCellStartHtmlCode()

Get the HTML code to start each section cell in the matrix with.

Returns:

The section cell start HTML code.

setCellStartHtmlCode

public void setCellStartHtmlCode(java.lang.Object pCode)

getCellEndHtmlCode

@Input
public java.lang.String getCellEndHtmlCode()

Get the HTML code to end each section cell in the matrix with.

Returns:

The section cell end HTML code.

setCellEndHtmlCode

public void setCellEndHtmlCode(java.lang.Object pCode)

getNumColumns

@Input
public int getNumColumns()

Get the number of columns to present the sections in. Default is 2.

Returns:

The number of columns.

setNumColumns

public void setNumColumns(int pNumColumns)