ar.com.fdvs.dj.domain

Class DynamicReportOptions

java.lang.Object

ar.com.fdvs.dj.domain.DJBaseElement

ar.com.fdvs.dj.domain.DynamicReportOptions

All Implemented Interfaces:

Entity, Serializable

public class DynamicReportOptions
extends DJBaseElement

Class that defines the report configuration.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DETAIL_HEIGHT
static int	DEFAULT_FOOTER_VARIABLES_HEIGHT
static int	DEFAULT_HEADER_HEIGHT
static int	DEFAULT_HEADER_VARIABLES_HEIGHT
static int	DEFAULT_MARGIN_BOTTOM
static int	DEFAULT_MARGIN_LEFT
static int	DEFAULT_MARGIN_RIGTH
static int	DEFAULT_MARGIN_TOP
static int	UNSET_VALUE

Fields inherited from interface ar.com.fdvs.dj.domain.entities.Entity

SERIAL_VERSION_UID

Constructor Summary

Constructors

Constructor and Description
DynamicReportOptions()

Method Summary

Modifier and Type	Method and Description
int	getBottomMargin()
int	getColumnSpace()
int	getColumnsPerPage()
int	getColumnWidth() Gives the printableWidth between the page margins that also considers the number of columns per page and the space between them.
Style	getDefaultDetailStyle()
Style	getDefaultFooterStyle()
Style	getDefaultGroupFooterStyle()
Style	getDefaultGroupHeaderStyle()
Style	getDefaultHeaderStyle()
int	getDetailHeight()
Map<ImageBanner.Alignment,ImageBanner>	getFirstPageFooterImageBanners()
Map<ImageBanner.Alignment,ImageBanner>	getFirstPageImageBanners()
Map<ImageBanner.Alignment,ImageBanner>	getFooterImageBanners()
int	getFooterVariablesHeight()
int	getHeaderHeight()
int	getHeaderVariablesHeight()
Map<ImageBanner.Alignment,ImageBanner>	getImageBanners()
int	getLeftMargin()
Style	getOddRowBackgroundStyle()
Page	getPage()
int	getPrintableWidth() Gives the printableWidth between the page margins.
int	getRightMargin()
int	getSubtitleHeight()
int	getTitleHeight()
int	getTopMargin()
boolean	isIgnorePagination()
boolean	isPrintBackgroundOnOddRows()
boolean	isPrintColumnNames()
boolean	isShowDetailBand()
boolean	isSummaryNewPage() When TRUE, the summary section will start in a new page
boolean	isTitleNewPage()
boolean	isUseFullPageWidth()
void	setBottomMargin(int bottomMargin)
void	setColumnSpace(int columnSpace)
void	setColumnsPerPage(int columnsPerPage)
void	setDefaultDetailStyle(Style defaultDetailStyle) Should not be null
void	setDefaultFooterStyle(Style defaultFooterStyle) Should not be null
void	setDefaultGroupFooterStyle(Style defaultGroupFooterStyle) Should not be null
void	setDefaultGroupHeaderStyle(Style defaultGroupHeaderStyle) Should not be null
void	setDefaultHeaderStyle(Style defaultHeaderStyle) Should not be null
void	setDetailHeight(int detailHeight)
void	setFooterVariablesHeight(int footerHeight)
void	setHeaderHeight(int headerHeight)
void	setHeaderVariablesHeight(int headerVariablesHeight)
void	setIgnorePagination(boolean ignorePagination)
void	setLeftMargin(int leftMargin)
void	setOddRowBackgroundStyle(Style oddRowBackgroundStyle)
void	setPage(Page page)
void	setPrintBackgroundOnOddRows(boolean printBackgroundOnOddRows)
void	setPrintColumnNames(boolean printColumnNames)
void	setRightMargin(int rightMargin)
void	setShowDetailBand(boolean showDetailBand)
void	setSubtitleHeight(int subtitleHeight)
void	setSummaryNewPage(boolean summaryNewPage)
void	setTitleHeight(int titleHeight)
void	setTitleNewPage(boolean titleNewPage)
void	setTopMargin(int topMargin)
void	setUseFullPageWidth(boolean useFullPageWidth)

Methods inherited from class java.lang.Object

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

Field Detail

UNSET_VALUE

public static final int UNSET_VALUE

See Also:

Constant Field Values

DEFAULT_HEADER_HEIGHT

public static final int DEFAULT_HEADER_HEIGHT

See Also:

Constant Field Values

DEFAULT_HEADER_VARIABLES_HEIGHT

public static final int DEFAULT_HEADER_VARIABLES_HEIGHT

See Also:

Constant Field Values

DEFAULT_FOOTER_VARIABLES_HEIGHT

public static final int DEFAULT_FOOTER_VARIABLES_HEIGHT

See Also:

Constant Field Values

DEFAULT_DETAIL_HEIGHT

public static final int DEFAULT_DETAIL_HEIGHT

See Also:

Constant Field Values

DEFAULT_MARGIN_TOP

public static final int DEFAULT_MARGIN_TOP

See Also:

Constant Field Values

DEFAULT_MARGIN_BOTTOM

public static final int DEFAULT_MARGIN_BOTTOM

See Also:

Constant Field Values

DEFAULT_MARGIN_LEFT

public static final int DEFAULT_MARGIN_LEFT

See Also:

Constant Field Values

DEFAULT_MARGIN_RIGTH

public static final int DEFAULT_MARGIN_RIGTH

See Also:

Constant Field Values

Constructor Detail

DynamicReportOptions

public DynamicReportOptions()

Method Detail

getFirstPageFooterImageBanners

public Map<ImageBanner.Alignment,ImageBanner> getFirstPageFooterImageBanners()

getImageBanners

public Map<ImageBanner.Alignment,ImageBanner> getImageBanners()

getFooterVariablesHeight

public int getFooterVariablesHeight()

setFooterVariablesHeight

public void setFooterVariablesHeight(int footerHeight)

getHeaderHeight

public int getHeaderHeight()

setHeaderHeight

public void setHeaderHeight(int headerHeight)

getDetailHeight

public int getDetailHeight()

setDetailHeight

public void setDetailHeight(int detailHeight)

getLeftMargin

public int getLeftMargin()

setLeftMargin

public void setLeftMargin(int leftMargin)

isUseFullPageWidth

public boolean isUseFullPageWidth()

setUseFullPageWidth

public void setUseFullPageWidth(boolean useFullPageWidth)

getBottomMargin

public int getBottomMargin()

setBottomMargin

public void setBottomMargin(int bottomMargin)

getRightMargin

public int getRightMargin()

setRightMargin

public void setRightMargin(int rightMargin)

getTopMargin

public int getTopMargin()

setTopMargin

public void setTopMargin(int topMargin)

getColumnsPerPage

public int getColumnsPerPage()

setColumnsPerPage

public void setColumnsPerPage(int columnsPerPage)

getColumnSpace

public int getColumnSpace()

setColumnSpace

public void setColumnSpace(int columnSpace)

getPage

public Page getPage()

setPage

public void setPage(Page page)

getPrintableWidth

public int getPrintableWidth()

Gives the printableWidth between the page margins.
pageTotalWidth - leftMargin - rightMargin

Returns:

int

getColumnWidth

public int getColumnWidth()

Gives the printableWidth between the page margins that also considers the
number of columns per page and the space between them.

Returns:

int

getOddRowBackgroundStyle

public Style getOddRowBackgroundStyle()

setOddRowBackgroundStyle

public void setOddRowBackgroundStyle(Style oddRowBackgroundStyle)

isPrintBackgroundOnOddRows

public boolean isPrintBackgroundOnOddRows()

setPrintBackgroundOnOddRows

public void setPrintBackgroundOnOddRows(boolean printBackgroundOnOddRows)

getTitleHeight

public int getTitleHeight()

getSubtitleHeight

public int getSubtitleHeight()

setSubtitleHeight

public void setSubtitleHeight(int subtitleHeight)

setTitleHeight

public void setTitleHeight(int titleHeight)

getFirstPageImageBanners

public Map<ImageBanner.Alignment,ImageBanner> getFirstPageImageBanners()

getDefaultDetailStyle

public Style getDefaultDetailStyle()

setDefaultDetailStyle

public void setDefaultDetailStyle(Style defaultDetailStyle)

Should not be null

Parameters:

defaultDetailStyle -

getDefaultFooterStyle

public Style getDefaultFooterStyle()

setDefaultFooterStyle

public void setDefaultFooterStyle(Style defaultFooterStyle)

Should not be null

Parameters:

defaultFooterStyle -

getDefaultHeaderStyle

public Style getDefaultHeaderStyle()

setDefaultHeaderStyle

public void setDefaultHeaderStyle(Style defaultHeaderStyle)

Should not be null

Parameters:

defaultHeaderStyle -

getDefaultGroupHeaderStyle

public Style getDefaultGroupHeaderStyle()

setDefaultGroupHeaderStyle

public void setDefaultGroupHeaderStyle(Style defaultGroupHeaderStyle)

Should not be null

Parameters:

defaultGroupHeaderStyle -

getDefaultGroupFooterStyle

public Style getDefaultGroupFooterStyle()

setDefaultGroupFooterStyle

public void setDefaultGroupFooterStyle(Style defaultGroupFooterStyle)

Should not be null

Parameters:

defaultGroupFooterStyle -

isTitleNewPage

public boolean isTitleNewPage()

setTitleNewPage

public void setTitleNewPage(boolean titleNewPage)

isPrintColumnNames

public boolean isPrintColumnNames()

setPrintColumnNames

public void setPrintColumnNames(boolean printColumnNames)

isIgnorePagination

public boolean isIgnorePagination()

setIgnorePagination

public void setIgnorePagination(boolean ignorePagination)

getHeaderVariablesHeight

public int getHeaderVariablesHeight()

setHeaderVariablesHeight

public void setHeaderVariablesHeight(int headerVariablesHeight)

isShowDetailBand

public boolean isShowDetailBand()

setShowDetailBand

public void setShowDetailBand(boolean showDetailBand)

isSummaryNewPage

public boolean isSummaryNewPage()

When TRUE, the summary section will start in a new page

Returns:

setSummaryNewPage

public void setSummaryNewPage(boolean summaryNewPage)

getFooterImageBanners

public Map<ImageBanner.Alignment,ImageBanner> getFooterImageBanners()