net.sf.jasperreports.engine.design
Class JRDesignBand

java.lang.Object
  extended by net.sf.jasperreports.engine.base.JRBaseElementGroup
      extended by net.sf.jasperreports.engine.design.JRDesignElementGroup
          extended by net.sf.jasperreports.engine.design.JRDesignBand
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, JRChangeEventsSupport, JRBand, JRChild, JRCloneable, JRElementGroup, JRVisitable

public class JRDesignBand
extends JRDesignElementGroup
implements JRBand

Version:
$Id: JRDesignBand.java 2002 2007-12-05 14:11:45Z teodord $
Author:
Teodor Danciu (teodord@users.sourceforge.net)
See Also:
Serialized Form

Field Summary
protected  int height
           
protected  boolean isSplitAllowed
           
protected  JRExpression printWhenExpression
           
static java.lang.String PROPERTY_HEIGHT
           
static java.lang.String PROPERTY_PRINT_WHEN_EXPRESSION
           
 
Fields inherited from class net.sf.jasperreports.engine.design.JRDesignElementGroup
PROPERTY_CHILDREN, PROPERTY_ELEMENT_GROUP
 
Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElementGroup
children, elementGroup
 
Constructor Summary
JRDesignBand()
           
 
Method Summary
 java.lang.Object clone()
           
 int getHeight()
           
 JROrigin getOrigin()
          Returns the band origin, i.e.
 JRExpression getPrintWhenExpression()
          Returns the boolean expression that specifies if the band will be displayed.
 boolean isSplitAllowed()
          Specifies if the band can be splitted between two pages.
 void setHeight(int height)
           
 void setPrintWhenExpression(JRExpression expression)
           
 void setSplitAllowed(boolean isSplitAllowed)
           
 
Methods inherited from class net.sf.jasperreports.engine.design.JRDesignElementGroup
addElement, addElementGroup, getEventSupport, removeElement, removeElementGroup, setElementGroup
 
Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElementGroup
clone, getChildren, getElementByKey, getElementByKey, getElementGroup, getElements, getElements, visit
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.sf.jasperreports.engine.JRElementGroup
getChildren, getElementByKey, getElementGroup, getElements
 
Methods inherited from interface net.sf.jasperreports.engine.JRChild
clone
 
Methods inherited from interface net.sf.jasperreports.engine.JRVisitable
visit
 

Field Detail

PROPERTY_HEIGHT

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

PROPERTY_PRINT_WHEN_EXPRESSION

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

height

protected int height

isSplitAllowed

protected boolean isSplitAllowed

printWhenExpression

protected JRExpression printWhenExpression
Constructor Detail

JRDesignBand

public JRDesignBand()
Method Detail

getHeight

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

setHeight

public void setHeight(int height)

isSplitAllowed

public boolean isSplitAllowed()
Description copied from interface: JRBand
Specifies if the band can be splitted between two pages.

Specified by:
isSplitAllowed in interface JRBand

setSplitAllowed

public void setSplitAllowed(boolean isSplitAllowed)
Specified by:
setSplitAllowed 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 setDetail/ setTitle/ setGroupHeader methods).

Returns:
the band origin

clone

public java.lang.Object clone()
Specified by:
clone in interface JRCloneable
Overrides:
clone in class JRBaseElementGroup


© 2001-2006 JasperSoft Corporation www.jaspersoft.com