com.stimulsoft.report.engine.engineV2.builders
Class StiDataBandV2Builder

java.lang.Object
  extended by com.stimulsoft.report.engine.StiBuilder
      extended by com.stimulsoft.report.engine.engineV2.builders.StiV2Builder
          extended by com.stimulsoft.report.engine.engineV2.builders.StiComponentV2Builder
              extended by com.stimulsoft.report.engine.engineV2.builders.StiContainerV2Builder
                  extended by com.stimulsoft.report.engine.engineV2.builders.StiBandV2Builder
                      extended by com.stimulsoft.report.engine.engineV2.builders.StiDataBandV2Builder
Direct Known Subclasses:
StiHierarchicalBandV2Builder, StiTableOfContentsV2Builder

public class StiDataBandV2Builder
extends StiBandV2Builder


Constructor Summary
StiDataBandV2Builder()
           
 
Method Summary
 void AddFooterMarker(StiDataBand masterDataBand, StiFooterBand footerMaster)
          Adds the Footer Marker to the end of a list, if before the list FooterBands were output on all pages.
 void AddKeepDetails(StiDataBand masterDataBand)
           
 void AddKeepLevel(StiDataBand masterDataBand)
           
 void AddKeepLevelAtLatestDataBand(StiDataBand masterDataBand)
           
 boolean AllowDetailDataBands(StiDataBand masterDataBand)
           
 boolean AllowKeepDetails(StiDataBand masterDataBand)
           
 void Block(StiDataBand masterDataBand)
           
 void CheckHierarchicalFooters(StiDataBand masterDataBand)
           
 void CheckHierarchicalHeaders(StiDataBand masterDataBand)
           
 boolean CheckKeepReportSummaryTogether(StiDataBand masterDataBand)
           
 void EndBands(StiDataBand masterDataBand)
          Ends monitoring of band OnAllPages.
 void FindDetailDataBands(StiDataBand masterDataBand)
           
 void FindDetails(StiDataBand masterDataBand)
           
 void FindEmptyBands(StiDataBand masterDataBand)
           
 void FindFooters(StiDataBand masterDataBand)
           
 void FindGroupFooters(StiDataBand masterDataBand)
           
 void FindGroupHeaders(StiDataBand masterDataBand)
           
 void FindHeaders(StiDataBand masterDataBand)
           
 void FindHierarchicalFooters(StiDataBand masterDataBand)
           
 void FindHierarchicalHeaders(StiDataBand masterDataBand)
           
 void FindSubReports(StiDataBand masterDataBand)
           
static StiV2Builder getBuilder(java.lang.Class<StiDataBand> class1)
           
 boolean GetGroupFooterResult(StiDataBand masterDataBand, StiGroupHeaderBand groupHeaderBand)
           
 java.util.ArrayList<StiGroupFooterBand> GetGroupFooters(StiDataBand masterDataBand)
          Returns a collection of group footers.
 boolean GetGroupHeaderResult(StiDataBand masterDataBand, StiGroupHeaderBand groupHeaderBand)
           
 java.util.ArrayList<StiGroupHeaderBand> GetGroupHeaders(StiDataBand masterDataBand)
          Returns a collection of group headers.
 void GroupsComparison(StiDataBand masterDataBand)
          All GroupFooters are placed on their GroupHeader(is set property - Header).
static boolean IsCollapsed(StiContainer masterDataBand, boolean isRendering)
           
 boolean IsDenyDetailsOnFirstPage(StiDataBand masterDataBand)
           
static boolean IsDetailDataSourcesEmpty(StiDataBand masterDataBand)
          Gets value indicates that all detail components are empty.
static boolean IsPrintIfDetailEmpty(StiDataBand masterDataBand)
           
 void LinkGroupHeadersAndGroupFooters(StiDataBand masterDataBand)
           
 void Prepare(StiComponent masterComp)
          Prepares a component for rendering.
static void PrepareGroupResults(StiDataBand masterDataBand)
          Prepares a groups result for each group for the current line.
 void RegisterEmptyBands(StiDataBand masterDataBand)
           
 void RemoveKeepDetails(StiDataBand masterDataBand)
           
 void RemoveKeepGroupHeaders(StiDataBand masterDataBand)
           
 void RemoveKeepHeaders(StiDataBand masterDataBand)
           
 void RemoveKeepLevel(StiDataBand masterDataBand)
           
 StiComponent Render(StiComponent masterComp)
          Renders a component with calling an event.
 void RenderBand(StiDataBand masterDataBand, StiBand band)
           
 void RenderBand(StiDataBand masterDataBand, StiBand band, boolean ignorePageBreaks, boolean allowRenderingEvents)
           
 void RenderColumns(StiDataBand masterDataBand)
           
 void RenderDetailDataBands(StiDataBand masterDataBand)
           
 void RenderFootersOnAllPages(StiDataBand masterDataBand)
           
 void RenderFootersOnLastPage(StiDataBand masterDataBand)
           
 void RenderGroupFooters(StiDataBand masterDataBand)
          Renders all group footers of this databand.
 void RenderGroupHeaders(StiDataBand masterDataBand)
          Renders all group headers of this databand.
 void RenderHeaders(StiDataBand masterDataBand)
           
 void RenderHierarchicalFooters(StiDataBand masterDataBand, boolean allowIndent, int level)
           
 void RenderHierarchicalHeaders(StiDataBand masterDataBand, boolean allowIndent, int level)
           
 void RenderMarkerFootersOnAllPages(StiDataBand masterDataBand)
           
 void RenderMaster(StiDataBand masterDataBand)
           
 void RenderReportSummaries(StiDataBand masterDataBand)
           
 void RenderReportTitles(StiDataBand masterDataBand)
           
 void ResetDetailDataBands(StiDataBand masterDataBand)
           
 void ResetDetails(StiDataBand masterDataBand)
           
 void ResetEmptyBands(StiDataBand masterDataBand)
           
 void ResetFooters(StiDataBand masterDataBand)
           
 void ResetGroupFooters(StiDataBand masterDataBand)
           
 void ResetGroupHeaders(StiDataBand masterDataBand)
           
 void ResetHeaders(StiDataBand masterDataBand)
           
 void ResetHierarchicalFooters(StiDataBand masterDataBand)
           
 void ResetHierarchicalHeaders(StiDataBand masterDataBand)
           
 void ResetLinkGroupHeadersAndGroupFooters(StiDataBand masterDataBand)
           
static void SetDetails(StiDataBand masterDataBand)
          Sets detail.
 void SetReportVariables(StiComponent masterComp)
          Sets system variables which are specific for the specified component.
 void StartBand(StiDataBand masterDataBand, StiBand band)
          Starts monitoring of specified band OnAllPages.
 void StartBands(StiDataBand masterDataBand, java.util.ArrayList<? extends StiBand> bands)
          Starts monitoring of specified collection of bands OnAllPages.
 void UnBlock(StiDataBand masterDataBand)
           
 void UnPrepare(StiComponent masterComp)
          Clears a component after rendering.
 
Methods inherited from class com.stimulsoft.report.engine.engineV2.builders.StiBandV2Builder
GetChildBands, GetSubReports, InternalRender
 
Methods inherited from class com.stimulsoft.report.engine.engineV2.builders.StiContainerV2Builder
GetRenderContainer
 
Methods inherited from class com.stimulsoft.report.engine.engineV2.builders.StiV2Builder
GetBuilder
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StiDataBandV2Builder

public StiDataBandV2Builder()
Method Detail

FindHeaders

public final void FindHeaders(StiDataBand masterDataBand)

FindHierarchicalHeaders

public final void FindHierarchicalHeaders(StiDataBand masterDataBand)

FindFooters

public final void FindFooters(StiDataBand masterDataBand)

FindHierarchicalFooters

public final void FindHierarchicalFooters(StiDataBand masterDataBand)

FindEmptyBands

public final void FindEmptyBands(StiDataBand masterDataBand)

FindGroupHeaders

public final void FindGroupHeaders(StiDataBand masterDataBand)

FindGroupFooters

public final void FindGroupFooters(StiDataBand masterDataBand)

FindDetailDataBands

public final void FindDetailDataBands(StiDataBand masterDataBand)

FindSubReports

public final void FindSubReports(StiDataBand masterDataBand)

FindDetails

public final void FindDetails(StiDataBand masterDataBand)

ResetHeaders

public final void ResetHeaders(StiDataBand masterDataBand)

ResetHierarchicalHeaders

public final void ResetHierarchicalHeaders(StiDataBand masterDataBand)

ResetFooters

public final void ResetFooters(StiDataBand masterDataBand)

ResetHierarchicalFooters

public final void ResetHierarchicalFooters(StiDataBand masterDataBand)

ResetEmptyBands

public final void ResetEmptyBands(StiDataBand masterDataBand)

ResetGroupHeaders

public final void ResetGroupHeaders(StiDataBand masterDataBand)

ResetGroupFooters

public final void ResetGroupFooters(StiDataBand masterDataBand)

ResetDetailDataBands

public final void ResetDetailDataBands(StiDataBand masterDataBand)

ResetDetails

public final void ResetDetails(StiDataBand masterDataBand)

AddKeepLevelAtLatestDataBand

public final void AddKeepLevelAtLatestDataBand(StiDataBand masterDataBand)

AddKeepLevel

public final void AddKeepLevel(StiDataBand masterDataBand)

RemoveKeepLevel

public final void RemoveKeepLevel(StiDataBand masterDataBand)

RemoveKeepGroupHeaders

public final void RemoveKeepGroupHeaders(StiDataBand masterDataBand)

RemoveKeepHeaders

public final void RemoveKeepHeaders(StiDataBand masterDataBand)

AllowKeepDetails

public final boolean AllowKeepDetails(StiDataBand masterDataBand)

AddKeepDetails

public final void AddKeepDetails(StiDataBand masterDataBand)

RemoveKeepDetails

public final void RemoveKeepDetails(StiDataBand masterDataBand)

StartBands

public final void StartBands(StiDataBand masterDataBand,
                             java.util.ArrayList<? extends StiBand> bands)
Starts monitoring of specified collection of bands OnAllPages.


StartBand

public final void StartBand(StiDataBand masterDataBand,
                            StiBand band)
Starts monitoring of specified band OnAllPages.


EndBands

public final void EndBands(StiDataBand masterDataBand)
Ends monitoring of band OnAllPages.


GetGroupHeaderResult

public final boolean GetGroupHeaderResult(StiDataBand masterDataBand,
                                          StiGroupHeaderBand groupHeaderBand)

GetGroupFooterResult

public final boolean GetGroupFooterResult(StiDataBand masterDataBand,
                                          StiGroupHeaderBand groupHeaderBand)

LinkGroupHeadersAndGroupFooters

public final void LinkGroupHeadersAndGroupFooters(StiDataBand masterDataBand)

ResetLinkGroupHeadersAndGroupFooters

public final void ResetLinkGroupHeadersAndGroupFooters(StiDataBand masterDataBand)

PrepareGroupResults

public static void PrepareGroupResults(StiDataBand masterDataBand)
Prepares a groups result for each group for the current line.


RenderGroupHeaders

public final void RenderGroupHeaders(StiDataBand masterDataBand)
Renders all group headers of this databand.


RenderGroupFooters

public final void RenderGroupFooters(StiDataBand masterDataBand)
Renders all group footers of this databand.


SetDetails

public static void SetDetails(StiDataBand masterDataBand)
Sets detail.


RenderDetailDataBands

public final void RenderDetailDataBands(StiDataBand masterDataBand)

AllowDetailDataBands

public final boolean AllowDetailDataBands(StiDataBand masterDataBand)

IsDenyDetailsOnFirstPage

public final boolean IsDenyDetailsOnFirstPage(StiDataBand masterDataBand)

IsDetailDataSourcesEmpty

public static boolean IsDetailDataSourcesEmpty(StiDataBand masterDataBand)
Gets value indicates that all detail components are empty.


IsPrintIfDetailEmpty

public static boolean IsPrintIfDetailEmpty(StiDataBand masterDataBand)

RenderHeaders

public final void RenderHeaders(StiDataBand masterDataBand)

RenderHierarchicalHeaders

public final void RenderHierarchicalHeaders(StiDataBand masterDataBand,
                                            boolean allowIndent,
                                            int level)

AddFooterMarker

public final void AddFooterMarker(StiDataBand masterDataBand,
                                  StiFooterBand footerMaster)
Adds the Footer Marker to the end of a list, if before the list FooterBands were output on all pages.


RenderMarkerFootersOnAllPages

public final void RenderMarkerFootersOnAllPages(StiDataBand masterDataBand)

RenderFootersOnLastPage

public final void RenderFootersOnLastPage(StiDataBand masterDataBand)

RenderFootersOnAllPages

public final void RenderFootersOnAllPages(StiDataBand masterDataBand)

RenderHierarchicalFooters

public final void RenderHierarchicalFooters(StiDataBand masterDataBand,
                                            boolean allowIndent,
                                            int level)

RenderReportTitles

public final void RenderReportTitles(StiDataBand masterDataBand)

RenderReportSummaries

public final void RenderReportSummaries(StiDataBand masterDataBand)

CheckKeepReportSummaryTogether

public final boolean CheckKeepReportSummaryTogether(StiDataBand masterDataBand)

Block

public final void Block(StiDataBand masterDataBand)

UnBlock

public final void UnBlock(StiDataBand masterDataBand)

CheckHierarchicalHeaders

public final void CheckHierarchicalHeaders(StiDataBand masterDataBand)

CheckHierarchicalFooters

public final void CheckHierarchicalFooters(StiDataBand masterDataBand)

RenderBand

public final void RenderBand(StiDataBand masterDataBand,
                             StiBand band)

RenderBand

public final void RenderBand(StiDataBand masterDataBand,
                             StiBand band,
                             boolean ignorePageBreaks,
                             boolean allowRenderingEvents)

RenderColumns

public final void RenderColumns(StiDataBand masterDataBand)

RegisterEmptyBands

public final void RegisterEmptyBands(StiDataBand masterDataBand)

IsCollapsed

public static boolean IsCollapsed(StiContainer masterDataBand,
                                  boolean isRendering)

SetReportVariables

public void SetReportVariables(StiComponent masterComp)
Sets system variables which are specific for the specified component.

Overrides:
SetReportVariables in class StiComponentV2Builder

Prepare

public void Prepare(StiComponent masterComp)
Description copied from class: StiComponentV2Builder
Prepares a component for rendering.

Overrides:
Prepare in class StiBandV2Builder

UnPrepare

public void UnPrepare(StiComponent masterComp)
Clears a component after rendering.

Overrides:
UnPrepare in class StiComponentV2Builder

Render

public StiComponent Render(StiComponent masterComp)
Description copied from class: StiV2Builder
Renders a component with calling an event. A method is used with InternalRender for the component rendering.

Overrides:
Render in class StiComponentV2Builder
Returns:

RenderMaster

public void RenderMaster(StiDataBand masterDataBand)

GetGroupHeaders

public java.util.ArrayList<StiGroupHeaderBand> GetGroupHeaders(StiDataBand masterDataBand)
Returns a collection of group headers.

Returns:
Components collection.

GetGroupFooters

public java.util.ArrayList<StiGroupFooterBand> GetGroupFooters(StiDataBand masterDataBand)
Returns a collection of group footers.

Returns:
Components collection.

GroupsComparison

public void GroupsComparison(StiDataBand masterDataBand)
All GroupFooters are placed on their GroupHeader(is set property - Header).


getBuilder

public static StiV2Builder getBuilder(java.lang.Class<StiDataBand> class1)