Package com.stimulsoft.report.engine.engineV2

Class StiBreakableHelper

java.lang.Object

com.stimulsoft.report.engine.engineV2.StiBreakableHelper

public class StiBreakableHelper
extends Object

A class that helps to work with the IStiBreakable interface.

Field Summary

Fields

Modifier and Type	Field	Description
StiEngine	engine

Constructor Summary

Constructors

Constructor	Description
StiBreakableHelper(StiEngine engine)

Method Summary

Modifier and Type	Method	Description
final StiContainer	Break(StiContainer originalContainer)	Breaks the specified container in two parts which are "Continued" and "Breaked", where the "Continued" is a container, which should be output on the next page and "Breaked" is a container which will be output on the current page.
final boolean	IsCanBreak(StiContainer container)	If a container can be broken into two parts, then returns true for the.
final boolean	IsNeedBreak(StiContainer container)	Returns true, if a container is to be broken and can be broken.
final StiContainer	ProcessBreakable(StiContainer container)	Checks the specified container on necessity to use the Breakable interface.
final void	SetCanBreak(StiContainer container)	Sets the CanBreak property for all components.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

engine

public StiEngine engine

Constructor Details

StiBreakableHelper

public StiBreakableHelper(StiEngine engine)

Method Details

IsCanBreak

public final boolean IsCanBreak(StiContainer container)

If a container can be broken into two parts, then returns true for the. True is returned, if the container realizes IStiBreakable interface and CanBreak is true, or ParentBand realizes IStiBreakable interface and CanBreak is true.

IsNeedBreak

public final boolean IsNeedBreak(StiContainer container)

Returns true, if a container is to be broken and can be broken. A container may need in breaking, if it is higher than free space available for output. The ability of break is checked with the IsCanBreak method.

Break

public final StiContainer Break(StiContainer originalContainer)

Breaks the specified container in two parts which are "Continued" and "Breaked", where the "Continued" is a container, which should be output on the next page and "Breaked" is a container which will be output on the current page. A container passed as the originalContainer method parameter contains the "Breaked" container. This method returns the "Continued" container.

SetCanBreak

public final void SetCanBreak(StiContainer container)

Sets the CanBreak property for all components. Do not set CanBreak to true for CrossFields and SubReports.

Parameters:

container -

ProcessBreakable

public final StiContainer ProcessBreakable(StiContainer container)

Checks the specified container on necessity to use the Breakable interface. Until a container cannot be placed completely on a page (and it can be broken) it is broken and output on pages.