ro.nextreports.engine
Class ReportLayout

Package class diagram package ReportLayout
java.lang.Object
  extended by ro.nextreports.engine.ReportLayout
All Implemented Interfaces:
java.io.Serializable

public class ReportLayout
extends java.lang.Object
implements java.io.Serializable

See Also:
Serialized Form

Field Summary
static java.lang.String A0
           
static java.lang.String A1
           
static java.lang.String A2
           
static java.lang.String A3
           
static java.lang.String A4
           
static int ALL_GROUP_MASK
           
static java.lang.String CUSTOM
           
static java.lang.String DETAIL_BAND_NAME
           
static java.lang.String FOOTER_BAND_NAME
           
static int FOOTER_GROUP_MASK
           
static java.lang.String GROUP_FOOTER_BAND_NAME_PREFIX
           
static java.lang.String GROUP_HEADER_BAND_NAME_PREFIX
           
static java.lang.String HEADER_BAND_NAME
           
static int HEADER_GROUP_MASK
           
static java.lang.String LEDGER
           
static java.lang.String LEGAL
           
static java.lang.String LETTER
           
static java.lang.String PAGE_FOOTER_BAND_NAME
           
static java.lang.String PAGE_HEADER_BAND_NAME
           
static java.lang.String TABLOID
           
 
Constructor Summary
ReportLayout()
           
 
Method Summary
 void addGroup(ReportGroup group, int groupMask)
           
 void clear()
           
 void editGroup(java.lang.String groupName, java.lang.String newColumnName, boolean headerOnEveryPage, boolean newPageAfter)
           
 boolean equals(java.lang.Object o)
           
 java.lang.String getBackgroundImage()
           
 ro.nextreports.engine.band.Band getBand(java.lang.String name)
           
 int getBandIndex(java.lang.String bandName)
           
 java.util.List<java.lang.String> getBandNamesAfter(int index)
           
 java.util.List<java.lang.String> getBandNamesAfter(java.lang.String bandName)
           
 java.util.List<ro.nextreports.engine.band.Band> getBands()
           
 java.util.List<ro.nextreports.engine.band.Band> getBandsAfter(int index)
           
 java.util.List<ro.nextreports.engine.band.Band> getBandsAfter(java.lang.String bandName)
           
 ro.nextreports.engine.band.ChartBandElement getChartBandElement(java.lang.String chartName)
           
 int getColumnCount()
           
 java.util.List<java.lang.Integer> getColumnsWidth()
           
 ro.nextreports.engine.band.Band getDetailBand()
           
 java.util.List<ro.nextreports.engine.band.Band> getDocumentBands()
          Get bands that appear in document page (no header page and footer page)
 ro.nextreports.engine.band.Band getFooterBand()
           
 java.util.Set<java.lang.String> getFunctions()
           
 java.util.Set<java.lang.String> getFunctions(java.lang.String bandName)
           
 int getGridRow(java.lang.String bandName, int bandRow)
           
 ReportGroup getGroup(java.lang.String groupName)
           
 java.util.List<ro.nextreports.engine.band.Band> getGroupFooterBands()
           
 java.util.List<ro.nextreports.engine.band.Band> getGroupHeaderBands()
           
 java.util.List<ReportGroup> getGroups()
           
 ro.nextreports.engine.band.Band getHeaderBand()
           
 java.util.List<ro.nextreports.engine.band.Band> getNotEmptyBands()
           
 int getOrientation()
           
 ro.nextreports.engine.band.Band getPageFooterBand()
           
 java.lang.String getPageFormat()
           
static java.lang.String[] getPageFormats()
           
 ro.nextreports.engine.band.Band getPageHeaderBand()
           
 ro.nextreports.engine.band.Padding getPagePadding()
           
 ro.nextreports.engine.band.PaperSize getPaperSize()
           
 ro.nextreports.engine.band.ReportBandElement getReportBandElement(java.lang.String reportName)
           
 int getReportType()
           
 int getRowCount()
           
 int hashCode()
           
 void initBandsListenerList()
           
 boolean isHeaderOnEveryPage()
           
 boolean isUseSize()
           
 void removeGroup(java.lang.String groupName)
           
 void setBackgroundImage(java.lang.String backgroundImage)
           
 void setColumnsWidth(java.util.List<java.lang.Integer> columnsWidth)
           
 void setHeaderOnEveryPage(boolean headerOnEveryPage)
           
 void setOrientation(int orientation)
           
 void setPageFormat(java.lang.String pageFormat)
           
 void setPagePadding(ro.nextreports.engine.band.Padding pagePadding)
           
 void setPaperSize(ro.nextreports.engine.band.PaperSize paperSize)
           
 void setReportType(int reportType)
           
 void setUseSize(boolean useSize)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HEADER_GROUP_MASK

public static final int HEADER_GROUP_MASK
See Also:
Constant Field Values

FOOTER_GROUP_MASK

public static final int FOOTER_GROUP_MASK
See Also:
Constant Field Values

ALL_GROUP_MASK

public static final int ALL_GROUP_MASK
See Also:
Constant Field Values

HEADER_BAND_NAME

public static final java.lang.String HEADER_BAND_NAME
See Also:
Constant Field Values

PAGE_HEADER_BAND_NAME

public static final java.lang.String PAGE_HEADER_BAND_NAME
See Also:
Constant Field Values

DETAIL_BAND_NAME

public static final java.lang.String DETAIL_BAND_NAME
See Also:
Constant Field Values

FOOTER_BAND_NAME

public static final java.lang.String FOOTER_BAND_NAME
See Also:
Constant Field Values

PAGE_FOOTER_BAND_NAME

public static final java.lang.String PAGE_FOOTER_BAND_NAME
See Also:
Constant Field Values

GROUP_HEADER_BAND_NAME_PREFIX

public static final java.lang.String GROUP_HEADER_BAND_NAME_PREFIX
See Also:
Constant Field Values

GROUP_FOOTER_BAND_NAME_PREFIX

public static final java.lang.String GROUP_FOOTER_BAND_NAME_PREFIX
See Also:
Constant Field Values

LETTER

public static final java.lang.String LETTER
See Also:
Constant Field Values

A0

public static final java.lang.String A0
See Also:
Constant Field Values

A1

public static final java.lang.String A1
See Also:
Constant Field Values

A2

public static final java.lang.String A2
See Also:
Constant Field Values

A3

public static final java.lang.String A3
See Also:
Constant Field Values

A4

public static final java.lang.String A4
See Also:
Constant Field Values

LEGAL

public static final java.lang.String LEGAL
See Also:
Constant Field Values

LEDGER

public static final java.lang.String LEDGER
See Also:
Constant Field Values

TABLOID

public static final java.lang.String TABLOID
See Also:
Constant Field Values

CUSTOM

public static final java.lang.String CUSTOM
See Also:
Constant Field Values
Constructor Detail

ReportLayout

public ReportLayout()
Method Detail

getColumnsWidth

public java.util.List<java.lang.Integer> getColumnsWidth()

setColumnsWidth

public void setColumnsWidth(java.util.List<java.lang.Integer> columnsWidth)

isUseSize

public boolean isUseSize()

setUseSize

public void setUseSize(boolean useSize)

getOrientation

public int getOrientation()

setOrientation

public void setOrientation(int orientation)

getReportType

public int getReportType()

setReportType

public void setReportType(int reportType)

getPageFormat

public java.lang.String getPageFormat()

setPageFormat

public void setPageFormat(java.lang.String pageFormat)

getPaperSize

public ro.nextreports.engine.band.PaperSize getPaperSize()

setPaperSize

public void setPaperSize(ro.nextreports.engine.band.PaperSize paperSize)

getBackgroundImage

public java.lang.String getBackgroundImage()

setBackgroundImage

public void setBackgroundImage(java.lang.String backgroundImage)

getPagePadding

public ro.nextreports.engine.band.Padding getPagePadding()

setPagePadding

public void setPagePadding(ro.nextreports.engine.band.Padding pagePadding)

isHeaderOnEveryPage

public boolean isHeaderOnEveryPage()

setHeaderOnEveryPage

public void setHeaderOnEveryPage(boolean headerOnEveryPage)

getDetailBand

public ro.nextreports.engine.band.Band getDetailBand()

getFooterBand

public ro.nextreports.engine.band.Band getFooterBand()

getHeaderBand

public ro.nextreports.engine.band.Band getHeaderBand()

getPageFooterBand

public ro.nextreports.engine.band.Band getPageFooterBand()

getPageHeaderBand

public ro.nextreports.engine.band.Band getPageHeaderBand()

getGroupHeaderBands

public java.util.List<ro.nextreports.engine.band.Band> getGroupHeaderBands()

getGroupFooterBands

public java.util.List<ro.nextreports.engine.band.Band> getGroupFooterBands()

getGroups

public java.util.List<ReportGroup> getGroups()

getBand

public ro.nextreports.engine.band.Band getBand(java.lang.String name)

getBandIndex

public int getBandIndex(java.lang.String bandName)

getBandNamesAfter

public java.util.List<java.lang.String> getBandNamesAfter(java.lang.String bandName)

getBandNamesAfter

public java.util.List<java.lang.String> getBandNamesAfter(int index)

getBandsAfter

public java.util.List<ro.nextreports.engine.band.Band> getBandsAfter(java.lang.String bandName)

getBandsAfter

public java.util.List<ro.nextreports.engine.band.Band> getBandsAfter(int index)

getGridRow

public int getGridRow(java.lang.String bandName,
                      int bandRow)

addGroup

public void addGroup(ReportGroup group,
                     int groupMask)

removeGroup

public void removeGroup(java.lang.String groupName)

editGroup

public void editGroup(java.lang.String groupName,
                      java.lang.String newColumnName,
                      boolean headerOnEveryPage,
                      boolean newPageAfter)

getGroup

public ReportGroup getGroup(java.lang.String groupName)

getBands

public java.util.List<ro.nextreports.engine.band.Band> getBands()
Returns:
List with 'sorted' bands.

getDocumentBands

public java.util.List<ro.nextreports.engine.band.Band> getDocumentBands()
Get bands that appear in document page (no header page and footer page)

Returns:
list of bands that appear in document page

getNotEmptyBands

public java.util.List<ro.nextreports.engine.band.Band> getNotEmptyBands()

getRowCount

public int getRowCount()

getColumnCount

public int getColumnCount()

clear

public void clear()

initBandsListenerList

public void initBandsListenerList()

getPageFormats

public static java.lang.String[] getPageFormats()

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getFunctions

public java.util.Set<java.lang.String> getFunctions()

getFunctions

public java.util.Set<java.lang.String> getFunctions(java.lang.String bandName)

getReportBandElement

public ro.nextreports.engine.band.ReportBandElement getReportBandElement(java.lang.String reportName)

getChartBandElement

public ro.nextreports.engine.band.ChartBandElement getChartBandElement(java.lang.String chartName)