Class FillPrepareResult
- java.lang.Object
-
- net.sf.jasperreports.engine.component.FillPrepareResult
-
public class FillPrepareResult extends Object
A result of acomponent fill preparation
.- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
-
-
Field Summary
Fields Modifier and Type Field Description static FillPrepareResult
NO_PRINT_NO_OVERFLOW
A result that indicates that the component will not print and does not require a band overflow.static FillPrepareResult
PRINT_NO_STRETCH
A result that indicates that the component will print, but will not stretch vertically.
-
Constructor Summary
Constructors Constructor Description FillPrepareResult(boolean toPrint, int stretchHeight, boolean overflow)
Creates a fill preparation result.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FillPrepareResult
addStretch(int delta)
int
getStretchHeight()
Returns the amount of vertical space consumed by the component.boolean
isToPrint()
Returns whether the component will produce a print element at the current position in the generated report.static FillPrepareResult
noPrintOverflow(int stretchHeight)
Returns a result that indicates that the component will not print (at the current position in the generated report), but requires an overflow so that it can print on a new column/page.static FillPrepareResult
printStretch(int stretchHeight, boolean overflow)
Returns a result which indicates that the component will print at the current position, and optionally consume more vertical space and/or require a band overflow.boolean
willOverflow()
Returns whether a band overflow is required in order to continue the component fill on a new column/page.
-
-
-
Field Detail
-
NO_PRINT_NO_OVERFLOW
public static final FillPrepareResult NO_PRINT_NO_OVERFLOW
A result that indicates that the component will not print and does not require a band overflow.This result would be used when the component does not intend to include any print element in the generated report.
-
PRINT_NO_STRETCH
public static final FillPrepareResult PRINT_NO_STRETCH
A result that indicates that the component will print, but will not stretch vertically.This would be used when the component will produce a print element that fits the space allocated at design time for the component element.
-
-
Constructor Detail
-
FillPrepareResult
public FillPrepareResult(boolean toPrint, int stretchHeight, boolean overflow)
Creates a fill preparation result.- Parameters:
toPrint
- indicates whether the component will produce a print element at the current position in the generated reportstretchHeight
- the amount of vertical space consumed by the componentoverflow
- indicates whether a band overflow is required in order to continue the component fill on a new column/page
-
-
Method Detail
-
noPrintOverflow
public static FillPrepareResult noPrintOverflow(int stretchHeight)
Returns a result that indicates that the component will not print (at the current position in the generated report), but requires an overflow so that it can print on a new column/page.- Parameters:
stretchHeight
- the height that is consumed by the component; usually this would be the same as theavailableHeight
argument passed toFillComponent.prepare(int)
- Returns:
- a result as described above
-
printStretch
public static FillPrepareResult printStretch(int stretchHeight, boolean overflow)
Returns a result which indicates that the component will print at the current position, and optionally consume more vertical space and/or require a band overflow.- Parameters:
stretchHeight
- the stretched height of the componentoverflow
- whether a band overflow is required so that the component would continue printing on a new column/page- Returns:
- a result that the component will print with the specified stretch height and overflow flag
-
isToPrint
public boolean isToPrint()
Returns whether the component will produce a print element at the current position in the generated report.- Returns:
- whether the component will print
-
willOverflow
public boolean willOverflow()
Returns whether a band overflow is required in order to continue the component fill on a new column/page.- Returns:
- whether a band overflow is required
-
getStretchHeight
public int getStretchHeight()
Returns the amount of vertical space consumed by the component.- Returns:
- the amount of vertical space consumed by the component
-
addStretch
public FillPrepareResult addStretch(int delta)
-
-