ar.com.fdvs.dj.core.layout

Class AbstractLayoutManager

java.lang.Object

ar.com.fdvs.dj.core.layout.AbstractLayoutManager

All Implemented Interfaces:

LayoutManager

Direct Known Subclasses:

ClassicLayoutManager, ListLayoutManager

public abstract class AbstractLayoutManager
extends Object
implements LayoutManager

Abstract Class used as base for the different Layout Managers.

A Layout Manager is always invoked after the entities registration stage.
A subclass should be created whenever we want to give the users the chance to
easily apply global layout changes to their reports. Example: Ignore groups
and styles for an Excel optimized report.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	EXPRESSION_TRUE_WHEN_EVEN
protected static String	EXPRESSION_TRUE_WHEN_ODD
protected List	realGroups Holds the original groups binded to a column.

Constructor Summary

Constructors

Constructor and Description
AbstractLayoutManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	addStyleToDesign(Style style)
void	applyLayout(net.sf.jasperreports.engine.design.JasperDesign design, DynamicReport report) Entry point for applying a given layout.
void	applyStyleToElement(Style style, net.sf.jasperreports.engine.design.JRDesignElement designElemen) Given a dj-Style, it is applied to the jasper element.
protected void	applyWaterMark()
protected net.sf.jasperreports.engine.design.JRDesignChart	createChart(DJChart djChart) Creates the JRDesignChart from the DJChart.
protected net.sf.jasperreports.engine.design.JRDesignChart	createChart(DJChart djChart, String name) Creates the JRDesignChart from the DJChart.
protected net.sf.jasperreports.engine.design.JRDesignBand	createGroupForChartAndGetBand(DJChart djChart)
protected net.sf.jasperreports.engine.design.JRDesignBand	createGroupForChartAndGetBand(DJChart djChart)
protected String	createUniqueStyleName()
protected void	endLayout()
protected void	ensureDJStyles() Sets a default style for every element that doesn't have one
protected void	generateHeaderBand(net.sf.jasperreports.engine.design.JRDesignBand band)
protected net.sf.jasperreports.engine.design.JRDesignTextField	generateTextFieldFromColumn(AbstractColumn col, int height, DJGroup group) Creates a JasperReport DesignTextField from a DynamicJasper AbstractColumn.
protected net.sf.jasperreports.engine.design.JRDesignGroup	getChartColumnsGroup(DJChart djChart)
protected net.sf.jasperreports.engine.design.JasperDesign	getDesign()
protected DJGroup	getDJGroup(AbstractColumn col)
protected net.sf.jasperreports.engine.design.JRDesignGroup	getJRGroupFromDJGroup(DJGroup group) Finds JRDesignGroup associated to a DJGroup
protected net.sf.jasperreports.engine.design.JRDesignGroup	getParent(net.sf.jasperreports.engine.design.JRDesignGroup group) Finds the parent group of the given one and returns it
protected DynamicReport	getReport()
HashMap	getReportStyles()
protected List<AbstractColumn>	getVisibleColumns()
protected void	interpeterOptions(DJChart djChart, net.sf.jasperreports.engine.design.JRDesignChart chart)
protected void	layoutCharts()
protected net.sf.jasperreports.engine.design.JRDesignConditionalStyle	makeConditionalStyle(Style style)
protected List	registerChartVariable(DJChart chart) Creates and registers a variable to be used by the Chart
protected Map	registerChartVariable(DJChart chart) Creates and registers a variable to be used by the Chart
protected void	registerRemainingStyles()
protected void	setBandFinalHeight(net.sf.jasperreports.engine.design.JRDesignBand band) Sets the band's height to hold all its children
protected void	setBandsFinalHeight() Sets the necessary height for all bands in the report, to hold their children
protected void	setColumnsFinalWidth() Sets the columns width by reading some report options like the printableArea and useFullPageWidth.
protected void	setDesign(net.sf.jasperreports.engine.design.JasperDesign design)
protected void	setReport(DynamicReport report)
void	setReportStyles(HashMap reportStyles)
protected void	setWhenNoDataBand() Creates the graphic element to be shown when the datasource is empty
protected void	startLayout()
protected void	transformDetailBand() For each column, puts the elements in the detail band
protected abstract void	transformDetailBandTextField(AbstractColumn column, net.sf.jasperreports.engine.design.JRDesignTextField textField)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ar.com.fdvs.dj.core.layout.LayoutManager

getReferencesMap

Field Detail

EXPRESSION_TRUE_WHEN_ODD

protected static final String EXPRESSION_TRUE_WHEN_ODD

See Also:

Constant Field Values

EXPRESSION_TRUE_WHEN_EVEN

protected static final String EXPRESSION_TRUE_WHEN_EVEN

See Also:

Constant Field Values

realGroups

protected final List realGroups

Holds the original groups binded to a column. Needed for later reference List

Constructor Detail

AbstractLayoutManager

public AbstractLayoutManager()

Method Detail

transformDetailBandTextField

protected abstract void transformDetailBandTextField(AbstractColumn column,
                                net.sf.jasperreports.engine.design.JRDesignTextField textField)

getReportStyles

public HashMap getReportStyles()

setReportStyles

public void setReportStyles(HashMap reportStyles)

applyLayout

public void applyLayout(net.sf.jasperreports.engine.design.JasperDesign design,
               DynamicReport report)
                 throws LayoutException

Description copied from interface: LayoutManager

Entry point for applying a given layout.

Specified by:

applyLayout in interface LayoutManager

Parameters:

design - The deseign to be used

report - The report to show

Throws:

LayoutException

applyWaterMark

protected void applyWaterMark()

setWhenNoDataBand

protected void setWhenNoDataBand()

Creates the graphic element to be shown when the datasource is empty

startLayout

protected void startLayout()

endLayout

protected void endLayout()

registerRemainingStyles

protected void registerRemainingStyles()

ensureDJStyles

protected void ensureDJStyles()

Sets a default style for every element that doesn't have one

Throws:

net.sf.jasperreports.engine.JRException

addStyleToDesign

public void addStyleToDesign(Style style)

Parameters:

style -

Throws:

net.sf.jasperreports.engine.JRException

createUniqueStyleName

protected String createUniqueStyleName()

transformDetailBand

protected void transformDetailBand()

For each column, puts the elements in the detail band

generateHeaderBand

protected void generateHeaderBand(net.sf.jasperreports.engine.design.JRDesignBand band)

applyStyleToElement

public void applyStyleToElement(Style style,
                       net.sf.jasperreports.engine.design.JRDesignElement designElemen)

Given a dj-Style, it is applied to the jasper element. If the style is being used by the first time, it is registered in the jasper-design, if it is the second time, the one created before is used (cached one)

Parameters:

style -

designElemen -

setColumnsFinalWidth

protected void setColumnsFinalWidth()

Sets the columns width by reading some report options like the printableArea and useFullPageWidth. columns with fixedWidth property set in TRUE will not be modified

getVisibleColumns

protected List<AbstractColumn> getVisibleColumns()

Returns:

A list of visible columns

setBandsFinalHeight

protected void setBandsFinalHeight()

Sets the necessary height for all bands in the report, to hold their children

setBandFinalHeight

protected void setBandFinalHeight(net.sf.jasperreports.engine.design.JRDesignBand band)

Sets the band's height to hold all its children

Parameters:

band - Band to be resized

generateTextFieldFromColumn

protected net.sf.jasperreports.engine.design.JRDesignTextField generateTextFieldFromColumn(AbstractColumn col,
                                                                               int height,
                                                                               DJGroup group)

Creates a JasperReport DesignTextField from a DynamicJasper AbstractColumn.

Parameters:

col -

height -

group -

Returns:

JRDesignTextField

makeConditionalStyle

protected net.sf.jasperreports.engine.design.JRDesignConditionalStyle makeConditionalStyle(Style style)

layoutCharts

protected void layoutCharts()

createGroupForChartAndGetBand

protected net.sf.jasperreports.engine.design.JRDesignBand createGroupForChartAndGetBand(DJChart djChart)

createChart

protected net.sf.jasperreports.engine.design.JRDesignChart createChart(DJChart djChart)

Creates the JRDesignChart from the DJChart. To do so it also creates needed variables and data-set

Parameters:

djChart -

Returns:

interpeterOptions

protected void interpeterOptions(DJChart djChart,
                     net.sf.jasperreports.engine.design.JRDesignChart chart)

registerChartVariable

protected List registerChartVariable(DJChart chart)

Creates and registers a variable to be used by the Chart

Parameters:

chart - Chart that needs a variable to be generated

Returns:

the generated variables

getChartColumnsGroup

protected net.sf.jasperreports.engine.design.JRDesignGroup getChartColumnsGroup(DJChart djChart)

createGroupForChartAndGetBand

protected net.sf.jasperreports.engine.design.JRDesignBand createGroupForChartAndGetBand(DJChart djChart)

createChart

protected net.sf.jasperreports.engine.design.JRDesignChart createChart(DJChart djChart,
                                                           String name)

Creates the JRDesignChart from the DJChart. To do so it also creates needed variables and data-set

Parameters:

djChart -

Returns:

registerChartVariable

protected Map registerChartVariable(DJChart chart)

Creates and registers a variable to be used by the Chart

Parameters:

chart - Chart that needs a variable to be generated

Returns:

the generated variables

getParent

protected net.sf.jasperreports.engine.design.JRDesignGroup getParent(net.sf.jasperreports.engine.design.JRDesignGroup group)

Finds the parent group of the given one and returns it

Parameters:

group - Group for which the parent is needed

Returns:

The parent group of the given one. If the given one is the first one, it returns the same group

getJRGroupFromDJGroup

protected net.sf.jasperreports.engine.design.JRDesignGroup getJRGroupFromDJGroup(DJGroup group)

Finds JRDesignGroup associated to a DJGroup

Parameters:

group -

Returns:

getDJGroup

protected DJGroup getDJGroup(AbstractColumn col)

getDesign

protected net.sf.jasperreports.engine.design.JasperDesign getDesign()

setDesign

protected void setDesign(net.sf.jasperreports.engine.design.JasperDesign design)

getReport

protected DynamicReport getReport()

setReport

protected void setReport(DynamicReport report)