Packagestimulsoft.report.engine.engineV2
Classpublic class StiBreakableHelper
InheritanceStiBreakableHelper Inheritance Object

A class that helps to work with the IStiBreakable interface.


Public Properties
 PropertyDefined By
  engine : StiEngine = null
StiBreakableHelper
Public Methods
 MethodDefined By
  
StiBreakableHelper(engine:StiEngine)
StiBreakableHelper
  
breakk(originalContainer:StiContainer):StiContainer
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.
StiBreakableHelper
  
isCanBreak(container:StiContainer):Boolean
If a container can be broken into two parts, then returns true for them.
StiBreakableHelper
  
isNeedBreak(container:StiContainer):Boolean
Returns true, if a container is to be broken and can be broken.
StiBreakableHelper
  
processBreakable(container:StiContainer):StiContainer
Checks the specified container on necessity to use the Breakable interface.
StiBreakableHelper
  
setCanBreak(container:StiContainer):void
Sets the CanBreak property for all components.
StiBreakableHelper
Property Detail
engineproperty
public var engine:StiEngine = null

Constructor Detail
StiBreakableHelper()Constructor
public function StiBreakableHelper(engine:StiEngine)



Parameters
engine:StiEngine
Method Detail
breakk()method
public function breakk(originalContainer:StiContainer):StiContainer

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.

Parameters

originalContainer:StiContainer

Returns
StiContainer
isCanBreak()method 
public function isCanBreak(container:StiContainer):Boolean

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

Parameters

container:StiContainer

Returns
Boolean
isNeedBreak()method 
public function isNeedBreak(container:StiContainer):Boolean

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.

Parameters

container:StiContainer

Returns
Boolean
processBreakable()method 
public function processBreakable(container:StiContainer):StiContainer

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.

Parameters

container:StiContainer

Returns
StiContainer
setCanBreak()method 
public function setCanBreak(container:StiContainer):void

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

Parameters

container:StiContainer





Mon Mar 27 2017, 09:08 AM +03:00