Package net.sf.jasperreports.engine.base

Class JRBaseGroup

java.lang.Object
net.sf.jasperreports.engine.base.JRBaseGroup
All Implemented Interfaces:
Serializable, Cloneable, JRChangeEventsSupport, JRCloneable, JRGroup, StoreCloneable<JRBaseGroup>
Direct Known Subclasses:
JRDesignGroup
public class JRBaseGroup extends Object implements JRGroup, Serializable, JRChangeEventsSupport, StoreCloneable<JRBaseGroup>
Author:
Teodor Danciu (teodord@users.sourceforge.net)
See Also:

  • Field Details

    • PROPERTY_MIN_HEIGHT_TO_START_NEW_PAGE

      public static final String PROPERTY_MIN_HEIGHT_TO_START_NEW_PAGE
      See Also:

    • PROPERTY_MIN_DETAILS_TO_START_FROM_TOP

      public static final String PROPERTY_MIN_DETAILS_TO_START_FROM_TOP
      See Also:

    • PROPERTY_KEEP_TOGETHER

      public static final String PROPERTY_KEEP_TOGETHER
      See Also:

    • PROPERTY_RESET_PAGE_NUMBER

      public static final String PROPERTY_RESET_PAGE_NUMBER
      See Also:

    • PROPERTY_REPRINT_HEADER_ON_EACH_PAGE

      public static final String PROPERTY_REPRINT_HEADER_ON_EACH_PAGE
      See Also:

    • PROPERTY_REPRINT_HEADER_ON_EACH_COLUMN

      public static final String PROPERTY_REPRINT_HEADER_ON_EACH_COLUMN
      See Also:

    • PROPERTY_START_NEW_COLUMN

      public static final String PROPERTY_START_NEW_COLUMN
      See Also:

    • PROPERTY_START_NEW_PAGE

      public static final String PROPERTY_START_NEW_PAGE
      See Also:

    • name

      protected String name

    • isStartNewColumn

      protected boolean isStartNewColumn

    • isStartNewPage

      protected boolean isStartNewPage

    • isResetPageNumber

      protected boolean isResetPageNumber

    • isReprintHeaderOnEachPage

      protected boolean isReprintHeaderOnEachPage

    • isReprintHeaderOnEachColumn

      protected boolean isReprintHeaderOnEachColumn

    • minHeightToStartNewPage

      protected int minHeightToStartNewPage

    • minDetailsToStartFromTop

      protected int minDetailsToStartFromTop

    • footerPosition

      protected FooterPositionEnum footerPosition

    • keepTogether

      protected boolean keepTogether

    • preventOrphanFooter

      protected boolean preventOrphanFooter

    • expression

      protected JRExpression expression

    • groupHeaderSection

      protected JRSection groupHeaderSection

    • groupFooterSection

      protected JRSection groupFooterSection

    • countVariable

      protected JRVariable countVariable

  • Constructor Details

  • Method Details

    • getName

      public String getName()
      Description copied from interface: JRGroup
      Gets the group name
      Specified by:
      getName 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • getGroupHeaderSection

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

    • getGroupFooterSection

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

    • getCountVariable

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

    • clone

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

    • clone

      public JRBaseGroup clone(CloneStore cloneStore)
      Specified by:
      clone in interface StoreCloneable<JRBaseGroup>

    • getEventSupport

      public JRPropertyChangeSupport getEventSupport()
      Description copied from interface: JRChangeEventsSupport
      Returns the property change support object for this instance.
      Specified by:
      getEventSupport in interface JRChangeEventsSupport
      Returns:
      the property change support object for this instance