net.sf.jasperreports.engine.base
Class JRBaseBreak

java.lang.Object
  net.sf.jasperreports.engine.base.JRBaseElement
      net.sf.jasperreports.engine.base.JRBaseBreak

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, JRChangeEventsSupport, JRBreak, JRChild, JRCloneable, JRCommonElement, JRElement, JRPropertiesHolder, JRStyleContainer, JRVisitable

public class JRBaseBreak
extends JRBaseElement
implements JRBreak

The actual implementation of a break element.

Version:

$Id: JRBaseBreak.java 3715 2010-04-08 18:08:49Z teodord $

Author:

Teodor Danciu ([email protected])

See Also:

Serialized Form

Field Summary

static java.lang.String	PROPERTY_TYPE
protected BreakTypeEnum	typeValue

Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElement

backcolor, defaultStyleProvider, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, modeValue, parentStyle, parentStyleNameReference, positionTypeValue, printWhenExpression, printWhenGroupChanges, PROPERTY_POSITION_TYPE, PROPERTY_PRINT_IN_FIRST_WHOLE_BAND, PROPERTY_PRINT_REPEATED_VALUES, PROPERTY_PRINT_WHEN_DETAIL_OVERFLOWS, PROPERTY_REMOVE_LINE_WHEN_BLANK, PROPERTY_STRETCH_TYPE, PROPERTY_WIDTH, PROPERTY_X, stretchTypeValue, width, x, y

Fields inherited from interface net.sf.jasperreports.engine.JRBreak

TYPE_COLUMN, TYPE_PAGE

Fields inherited from interface net.sf.jasperreports.engine.JRElement

MODE_OPAQUE, MODE_TRANSPARENT, POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM, POSITION_TYPE_FIX_RELATIVE_TO_TOP, POSITION_TYPE_FLOAT, STRETCH_TYPE_NO_STRETCH, STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT, STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT

Constructor Summary

protected

JRBaseBreak(JRBreak breakElement, JRBaseObjectFactory factory) Initializes properties that are specific to break elements.

Method Summary

void	collectExpressions(JRExpressionCollector collector)
int	getHeight()
byte	getType() Deprecated. Replaced by getTypeValue().
BreakTypeEnum	getTypeValue() Gets the break type.
int	getX() Gets the the section relative horizontal offset of the element top left corner.
void	setType(BreakTypeEnum typeValue) Sets the break type.
void	setType(byte type) Deprecated. Replaced by setType(BreakTypeEnum).
void	visit(JRVisitor visitor)

Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElement

clone, clone, getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getEventSupport, getForecolor, getKey, getMode, getModeValue, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, getParentProperties, getPositionType, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getPropertyExpressions, getStretchType, getStretchTypeValue, getStyle, getStyleNameReference, getWidth, getY, hasProperties, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setMode, setMode, setPositionType, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setStretchType, setWidth, setX

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

getElementGroup, getKey, getPositionType, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchType, getStretchTypeValue, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setStretchType, setWidth, setX

Methods inherited from interface net.sf.jasperreports.engine.JRChild

clone

Methods inherited from interface net.sf.jasperreports.engine.JRCloneable

clone

Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement

getBackcolor, getForecolor, getMode, getModeValue, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, getWidth, setBackcolor, setForecolor, setMode, setMode, setMode

Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer

getDefaultStyleProvider, getStyle, getStyleNameReference

Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder

getParentProperties, getPropertiesMap, hasProperties

Field Detail

PROPERTY_TYPE

public static final java.lang.String PROPERTY_TYPE

See Also:

Constant Field Values

typeValue

protected BreakTypeEnum typeValue

Constructor Detail

JRBaseBreak

protected JRBaseBreak(JRBreak breakElement,
                      JRBaseObjectFactory factory)

Initializes properties that are specific to break elements. Common properties are initialized by its parent constructors.

Parameters:

breakElement - an element whose properties are copied to this element. Usually it is a JRDesignBreak that must be transformed into an JRBaseBreak at compile time.

factory - a factory used in the compile process

Method Detail

getX

public int getX()

Description copied from interface: JRElement

Gets the the section relative horizontal offset of the element top left corner.

Specified by:

getX in interface JRElement

Overrides:

getX in class JRBaseElement

getHeight

public int getHeight()

Specified by:

getHeight in interface JRCommonElement

Overrides:

getHeight in class JRBaseElement

getType

public byte getType()

Deprecated. Replaced by getTypeValue().

Specified by:

getType in interface JRBreak

setType

public void setType(byte type)

Deprecated. Replaced by setType(BreakTypeEnum).

Specified by:

setType in interface JRBreak

getTypeValue

public BreakTypeEnum getTypeValue()

Description copied from interface: JRBreak

Gets the break type.

Specified by:

getTypeValue in interface JRBreak

Returns:

a value representing one of the break type constants in BreakTypeEnum

setType

public void setType(BreakTypeEnum typeValue)

Description copied from interface: JRBreak

Sets the break type.

Specified by:

setType in interface JRBreak

Parameters:

typeValue - a value representing one of the break type constants in BreakTypeEnum

collectExpressions

public void collectExpressions(JRExpressionCollector collector)

Specified by:

collectExpressions in interface JRElement

visit

public void visit(JRVisitor visitor)

Specified by:

visit in interface JRVisitable