Package net.sf.jasperreports.engine.fill

Class JRFillBand

java.lang.Object
net.sf.jasperreports.engine.fill.JRFillElementGroup
net.sf.jasperreports.engine.fill.JRFillElementContainer
net.sf.jasperreports.engine.fill.JRFillBand
All Implemented Interfaces:
Cloneable, FillContainerContext, JRFillCloneable, JROriginProvider, JRBand, JRChild, JRCloneable, JRElementGroup, JRPropertiesHolder, JRVisitable
public class JRFillBand extends JRFillElementContainer implements JRBand, JROriginProvider
Author:
Teodor Danciu (teodord@users.sourceforge.net)

  • Field Details

  • Constructor Details

  • Method Details

    • getOrigin

      public JROrigin getOrigin()
      Description copied from interface: JROriginProvider
      Returns an element origin.
      Specified by:
      getOrigin in interface JROriginProvider
      Returns:
      an element origin

    • setOrigin

      protected void setOrigin(JROrigin origin)

    • setNewPageColumn

      protected void setNewPageColumn(boolean isNew)

    • isNewPageColumn

      protected boolean isNewPageColumn()

    • isFirstWholeOnPageColumn

      protected boolean isFirstWholeOnPageColumn()
      Decides whether this band is the for whole band on the page/column.
      Returns:
      whether this band is the for whole band on the page/column

    • setNewGroup

      protected void setNewGroup(JRGroup group, boolean isNew)

    • isNewGroup

      protected boolean isNewGroup(String group)

    • getHeight

      public int getHeight()
      Specified by:
      getHeight in interface JRBand

    • getBreakHeight

      public int getBreakHeight()

    • getSplitType

      public SplitTypeEnum getSplitType()
      Description copied from interface: JRBand
      Specifies the band split behavior.
      Specified by:
      getSplitType in interface JRBand

    • setSplitType

      public void setSplitType(SplitTypeEnum splitType)
      Specified by:
      setSplitType in interface JRBand

    • getPrintWhenExpression

      public JRExpression getPrintWhenExpression()
      Description copied from interface: JRBand
      Returns the boolean expression that specifies if the band will be displayed.
      Specified by:
      getPrintWhenExpression in interface JRBand

    • isSplitPrevented

      protected boolean isSplitPrevented()

    • isPrintWhenExpressionNull

      protected boolean isPrintWhenExpressionNull()

    • isPrintWhenTrue

      protected boolean isPrintWhenTrue()

    • setPrintWhenTrue

      protected void setPrintWhenTrue(boolean isPrintWhenTrue)

    • isToPrint

      protected boolean isToPrint()

    • evaluatePrintWhenExpression

      protected void evaluatePrintWhenExpression(byte evaluation) throws JRException
      Throws:
      JRException

    • refill

      protected JRPrintBand refill(byte evaluation, int availableHeight) throws JRException
      Throws:
      JRException

    • fill

      protected JRPrintBand fill() throws JRException
      Throws:
      JRException

    • fill

      protected JRPrintBand fill(int availableHeight) throws JRException
      Throws:
      JRException

    • fill

      protected JRPrintBand fill(int availableHeight, boolean isOverflowAllowed) throws JRException
      Throws:
      JRException

    • willOverflowWithElements

      protected boolean willOverflowWithElements()

    • getContainerHeight

      protected int getContainerHeight()
      Description copied from class: JRFillElementContainer
      Returns the height of the element container.
      Specified by:
      getContainerHeight in class JRFillElementContainer
      Returns:
      the height of the element container

    • getActualContainerHeight

      protected int getActualContainerHeight()
      Description copied from class: JRFillElementContainer
      Returns the actual height of the element container. Some element containers such as frames have a larger calculated container height, resulting from content being placed beyond container declared height.
      Specified by:
      getActualContainerHeight in class JRFillElementContainer
      Returns:
      the height of the element container

    • isVariableUsedInReturns

      protected boolean isVariableUsedInReturns(String variableName)

    • addNowEvaluationTime

      protected void addNowEvaluationTime(JREvaluationTime evaluationTime)

    • addNowEvaluationTimes

      protected void addNowEvaluationTimes(JREvaluationTime[] evaluationTimes)

    • isNowEvaluationTime

      protected boolean isNowEvaluationTime(JREvaluationTime evaluationTime)

    • getId

      protected int getId()

    • evaluate

      protected void evaluate(byte evaluation) throws JRException
      Overrides:
      evaluate in class JRFillElementContainer
      Throws:
      JRException

    • resetSavedVariables

      protected void resetSavedVariables()

    • saveVariable

      protected void saveVariable(String variableName)

    • restoreSavedVariables

      protected void restoreSavedVariables()

    • isEmpty

      protected boolean isEmpty()

    • isColumnBand

      protected boolean isColumnBand()

    • isSplitTypePreventInhibited

      protected boolean isSplitTypePreventInhibited()

    • isSplitTypePreventInhibited

      public boolean isSplitTypePreventInhibited(boolean isTopLevelCall)
      Specified by:
      isSplitTypePreventInhibited in interface FillContainerContext

    • hasProperties

      public boolean hasProperties()
      Description copied from interface: JRPropertiesHolder
      Checks whether the object has any properties.
      Specified by:
      hasProperties in interface JRPropertiesHolder
      Returns:
      whether the object has any properties

    • getPropertiesMap

      public JRPropertiesMap getPropertiesMap()
      Description copied from interface: JRPropertiesHolder
      Returns this object's properties map.
      Specified by:
      getPropertiesMap in interface JRPropertiesHolder
      Returns:
      this object's properties map

    • getParentProperties

      public JRPropertiesHolder getParentProperties()
      Description copied from interface: JRPropertiesHolder
      Returns the parent properties holder, whose properties are used as defaults for this object.
      Specified by:
      getParentProperties in interface JRPropertiesHolder
      Returns:
      the parent properties holder, or null if no parent

    • getReturnValues

      public List<ExpressionReturnValue> getReturnValues()
      Description copied from interface: JRBand
      Returns the list of values to increment report variables with.
      Specified by:
      getReturnValues in interface JRBand
      Returns:
      the list of returned values.

    • registerReturnValues

      public void registerReturnValues(FillReturnValues fillReturnValues)