Package net.sf.jasperreports.components.table.fill

Class TableReportGroup

java.lang.Object
net.sf.jasperreports.components.table.fill.TableReportGroup
All Implemented Interfaces:
Cloneable, JRCloneable, JRGroup
public class TableReportGroup extends Object implements JRGroup
Author:
Lucian Chirita (lucianc@users.sourceforge.net)

  • Constructor Summary

    Constructors
    Constructor
    Description
    TableReportGroup(JRGroup datasetGroup)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
     
    JRVariable
    getCountVariable()
     
    JRExpression
    getExpression()
    Gets the expression that defines what records in the group have in common.
    FooterPositionEnum
    getFooterPosition()
    Specifies how the group footer section behaves with regards to its position on the current page.
    JRSection
    getGroupFooterSection()
    Gets the footer section created for this group.
    JRSection
    getGroupHeaderSection()
    Gets the header section created for this group.
    int
    getMinDetailsToStartFromTop()
    Gets the minimum number of details to be rendered on the current column, to avoid starting the group on a new column.
    int
    getMinHeightToStartNewPage()
    Gets the minimum amount of vertical space needed at the bottom of the column in order to place the group header on the current column.
    String
    getName()
    Gets the group name
    JRGroup
    getOriginalGroup()
     
    boolean
    isKeepTogether()
    Gets the flag that signals if the group should be prevented from splitting on first break attempt.
    boolean
    isPreventOrphanFooter()
    Gets the flag that signals if the group footer should be prevented from appearing without a detail at the top of a new page/column.
    boolean
    isReprintHeaderOnEachColumn()
    Gets the flag that signals if the group header should be reprinted at the beginning of each column, in vertically filled reports only.
    boolean
    isReprintHeaderOnEachPage()
    Gets the flag that signals if the group header should be reprinted at the beginning of each page.
    boolean
    isResetPageNumber()
    Gets the flag that signals if the group header should be printed always on a new page, along with the re-initialization of the page number.
    boolean
    isStartNewColumn()
    Gets the flag that signals if the group header should be printed always on a new column.
    boolean
    isStartNewPage()
    Gets the flag that signals if the group header should be printed always on a new page.
    void
    setFooterPosition(FooterPositionEnum footerPosition)
    Specifies the group footer section behavior with regards to its position on the current page.
    protected void
    setGroupFooter(JRBand footer)
     
    protected void
    setGroupHeader(JRBand header)
     
    void
    setKeepTogether(boolean keepTogether)
    Sets the flag that signals if the group should be prevented from splitting on first break attempt.
    void
    setMinDetailsToStartFromTop(int minDetails)
    Sets the minimum number of details to be rendered on the current column, to avoid starting the group on a new column.
    void
    setMinHeightToStartNewPage(int minHeight)
    Sets the minimum amount of vertical space needed at the bottom of the column in order to place the group header on the current column.
    void
    setPreventOrphanFooter(boolean preventOrphanFooter)
    Sets the flag that signals if the group should be prevented from appearing without a detail at the top of a new page/column.
    void
    setReprintHeaderOnEachColumn(boolean isReprint)
    Sets the flag that signals if the group header should be reprinted at the beginning of each column, in vertically filled reports only.
    void
    setReprintHeaderOnEachPage(boolean isReprint)
    Sets the flag that signals if the group header should be reprinted at the beginning of each page.
    void
    setResetPageNumber(boolean isReset)
    Sets the flag that signals if the group header should be printed always on a new page, along with the re-initialization of the page number.
    void
    setStartNewColumn(boolean isStart)
    Sets the flag that signals if the group header should be printed always on a new column.
    void
    setStartNewPage(boolean isStart)
    Sets the flag that signals if the group header should be printed always on a new page.
    protected JRSection
    wrapBand(JRBand band, BandTypeEnum bandType)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TableReportGroup

      public TableReportGroup(JRGroup datasetGroup)

  • Method Details

    • getCountVariable

      public JRVariable getCountVariable()
      Specified by:
      getCountVariable in interface JRGroup

    • getExpression

      public JRExpression getExpression()
      Description copied from interface: JRGroup
      Gets the expression that defines what records in the group have in common.
      Specified by:
      getExpression in interface JRGroup

    • getFooterPosition

      public FooterPositionEnum getFooterPosition()
      Description copied from interface: JRGroup
      Specifies how the group footer section behaves with regards to its position on the current page.
      Specified by:
      getFooterPosition in interface JRGroup

    • setGroupFooter

      protected void setGroupFooter(JRBand footer)

    • wrapBand

      protected JRSection wrapBand(JRBand band, BandTypeEnum bandType)

    • getGroupFooterSection

      public JRSection getGroupFooterSection()
      Description copied from interface: JRGroup
      Gets the footer section created for this group.
      Specified by:
      getGroupFooterSection in interface JRGroup

    • setGroupHeader

      protected void setGroupHeader(JRBand header)

    • getGroupHeaderSection

      public JRSection getGroupHeaderSection()
      Description copied from interface: JRGroup
      Gets the header section created for this group.
      Specified by:
      getGroupHeaderSection in interface JRGroup

    • getMinHeightToStartNewPage

      public int getMinHeightToStartNewPage()
      Description copied from interface: JRGroup
      Gets the minimum amount of vertical space needed at the bottom of the column in order to place the group header on the current column.
      Specified by:
      getMinHeightToStartNewPage in interface JRGroup

    • getMinDetailsToStartFromTop

      public int getMinDetailsToStartFromTop()
      Description copied from interface: JRGroup
      Gets the minimum number of details to be rendered on the current column, to avoid starting the group on a new column.
      Specified by:
      getMinDetailsToStartFromTop in interface JRGroup

    • getName

      public String getName()
      Description copied from interface: JRGroup
      Gets the group name
      Specified by:
      getName in interface JRGroup

    • isKeepTogether

      public boolean isKeepTogether()
      Description copied from interface: JRGroup
      Gets the flag that signals if the group should be prevented from splitting on first break attempt.
      Specified by:
      isKeepTogether in interface JRGroup

    • isPreventOrphanFooter

      public boolean isPreventOrphanFooter()
      Description copied from interface: JRGroup
      Gets the flag that signals if the group footer should be prevented from appearing without a detail at the top of a new page/column.
      Specified by:
      isPreventOrphanFooter in interface JRGroup

    • isReprintHeaderOnEachPage

      public boolean isReprintHeaderOnEachPage()
      Description copied from interface: JRGroup
      Gets the flag that signals if the group header should be reprinted at the beginning of each page.
      Specified by:
      isReprintHeaderOnEachPage in interface JRGroup

    • isReprintHeaderOnEachColumn

      public boolean isReprintHeaderOnEachColumn()
      Description copied from interface: JRGroup
      Gets the flag that signals if the group header should be reprinted at the beginning of each column, in vertically filled reports only.
      Specified by:
      isReprintHeaderOnEachColumn in interface JRGroup

    • isResetPageNumber

      public boolean isResetPageNumber()
      Description copied from interface: JRGroup
      Gets the flag that signals if the group header should be printed always on a new page, along with the re-initialization of the page number.
      Specified by:
      isResetPageNumber in interface JRGroup

    • isStartNewColumn

      public boolean isStartNewColumn()
      Description copied from interface: JRGroup
      Gets the flag that signals if the group header should be printed always on a new column.
      Specified by:
      isStartNewColumn in interface JRGroup

    • isStartNewPage

      public boolean isStartNewPage()
      Description copied from interface: JRGroup
      Gets the flag that signals if the group header should be printed always on a new page.
      Specified by:
      isStartNewPage in interface JRGroup

    • setFooterPosition

      public void setFooterPosition(FooterPositionEnum footerPosition)
      Description copied from interface: JRGroup
      Specifies the group footer section behavior with regards to its position on the current page.
      Specified by:
      setFooterPosition in interface JRGroup

    • setKeepTogether

      public void setKeepTogether(boolean keepTogether)
      Description copied from interface: JRGroup
      Sets the flag that signals if the group should be prevented from splitting on first break attempt.
      Specified by:
      setKeepTogether in interface JRGroup

    • setPreventOrphanFooter

      public void setPreventOrphanFooter(boolean preventOrphanFooter)
      Description copied from interface: JRGroup
      Sets the flag that signals if the group should be prevented from appearing without a detail at the top of a new page/column.
      Specified by:
      setPreventOrphanFooter in interface JRGroup

    • setMinHeightToStartNewPage

      public void setMinHeightToStartNewPage(int minHeight)
      Description copied from interface: JRGroup
      Sets the minimum amount of vertical space needed at the bottom of the column in order to place the group header on the current column.
      Specified by:
      setMinHeightToStartNewPage in interface JRGroup

    • setMinDetailsToStartFromTop

      public void setMinDetailsToStartFromTop(int minDetails)
      Description copied from interface: JRGroup
      Sets the minimum number of details to be rendered on the current column, to avoid starting the group on a new column.
      Specified by:
      setMinDetailsToStartFromTop in interface JRGroup

    • setReprintHeaderOnEachPage

      public void setReprintHeaderOnEachPage(boolean isReprint)
      Description copied from interface: JRGroup
      Sets the flag that signals if the group header should be reprinted at the beginning of each page.
      Specified by:
      setReprintHeaderOnEachPage in interface JRGroup

    • setReprintHeaderOnEachColumn

      public void setReprintHeaderOnEachColumn(boolean isReprint)
      Description copied from interface: JRGroup
      Sets the flag that signals if the group header should be reprinted at the beginning of each column, in vertically filled reports only.
      Specified by:
      setReprintHeaderOnEachColumn in interface JRGroup

    • setResetPageNumber

      public void setResetPageNumber(boolean isReset)
      Description copied from interface: JRGroup
      Sets the flag that signals if the group header should be printed always on a new page, along with the re-initialization of the page number.
      Specified by:
      setResetPageNumber in interface JRGroup

    • setStartNewColumn

      public void setStartNewColumn(boolean isStart)
      Description copied from interface: JRGroup
      Sets the flag that signals if the group header should be printed always on a new column.
      Specified by:
      setStartNewColumn in interface JRGroup

    • setStartNewPage

      public void setStartNewPage(boolean isStart)
      Description copied from interface: JRGroup
      Sets the flag that signals if the group header should be printed always on a new page.
      Specified by:
      setStartNewPage in interface JRGroup

    • clone

      public Object clone()
      Specified by:
      clone in interface JRCloneable
      Overrides:
      clone in class Object

    • getOriginalGroup

      public JRGroup getOriginalGroup()