Package net.sf.jasperreports.engine.design

Class JRDesignBand

java.lang.Object
net.sf.jasperreports.engine.base.JRBaseElementGroup
net.sf.jasperreports.engine.design.JRDesignElementGroup
net.sf.jasperreports.engine.design.JRDesignBand
All Implemented Interfaces:
Serializable, Cloneable, JRChangeEventsSupport, JRBand, JRChild, JRCloneable, JRElementGroup, JRPropertiesHolder, JRVisitable
public class JRDesignBand extends JRDesignElementGroup implements JRBand
Author:
Teodor Danciu (teodord@users.sourceforge.net)
See Also:

  • Field Details

  • Constructor Details

    • JRDesignBand

      public JRDesignBand()

  • Method Details

    • getHeight

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

    • setHeight

      public void setHeight(int height)

    • 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

    • setPrintWhenExpression

      public void setPrintWhenExpression(JRExpression expression)

    • getOrigin

      public JROrigin getOrigin()
      Returns the band origin, i.e. its location/role within the report (e.g. detail/title/group header/etc). The location is automatically set when the band is inserted into the report (via one of the setTitle / setPageHeader methods).
      Returns:
      the band origin

    • 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.

    • addReturnValue

      public void addReturnValue(ExpressionReturnValue returnValue)
      Adds a return value to the band.
      Parameters:
      returnValue - the return value to be added.

    • getReturnValuesList

      public List<ExpressionReturnValue> getReturnValuesList()
      Returns the list of values to increment report variables with.
      Returns:
      list of ReturnValue objects

    • removeReturnValue

      public boolean removeReturnValue(ExpressionReturnValue returnValue)
      Removes a return value from the band.
      Parameters:
      returnValue - the return value to be removed
      Returns:
      true if the return value was found and removed

    • clone

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

    • 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