com.stimulsoft.report.components.bands

Class StiDynamicBand

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.base.services.StiService

com.stimulsoft.report.StiBase

com.stimulsoft.report.components.StiComponent

com.stimulsoft.report.components.complexcomponents.StiContainer

com.stimulsoft.report.components.bands.StiBand

com.stimulsoft.report.components.bands.StiDynamicBand

All Implemented Interfaces:

IStiJsonReportObject, IStiForceSerializable, IStiSerializable, IStiSerializableRef, IStiSerializableToAttributes, IStiName, IStiBorder, IStiBreakable, IStiBrush, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiGrowToHeight, IStiInteraction, IStiPageBreak, IStiPrintAtBottom, IStiPrintOn, IStiResetPageNumber, IStiSelect, IStiShift, IStiUnitConvert, IStiReportProperty, IStiIgnoryStyle, IStiInherited, IStiStateSaveRestore, java.lang.Cloneable

Direct Known Subclasses:

StiChildBand, StiDataBand, StiFooterBand, StiGroupFooterBand, StiGroupHeaderBand, StiHeaderBand, StiReportSummaryBand

public abstract class StiDynamicBand
extends StiBand
implements IStiPageBreak, IStiBreakable, IStiPrintAtBottom

Field Summary

Fields inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer

border, brush, collapsingIndex, components, ParentComponentIsBand, ParentComponentIsCrossBand, PropertyBlocked

Fields inherited from class com.stimulsoft.report.components.StiComponent

canGrow, canShrink, componentPlacement, conditions, interaction, isRendered, page, parent, parentBookmark, PropertyComponentStyle, PropertyDelimiterComponent, PropertyDockable, PropertyInherited, PropertyLinked, PropertyLocked, PropertyMaxSize, PropertyMinSize, PropertyPlaceOnToolbox, PropertyRenderedCount, PropertyRestrictions, PropertySelectionTick, PropertyShowQuickButtons, PropertyUseParentStyles, top, width

Fields inherited from class com.stimulsoft.base.services.StiService

properties

Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor and Description
StiDynamicBand() Creates a new dynamic band.
StiDynamicBand(StiRectangle rect) Creates a new dynamic band.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	Break(StiComponent dividedComponent, double devideFactor, StiRefObject<java.lang.Double> divLine) Divides content of components in two parts.
float	getBreakIfLessThan() Gets or sets value which indicates how much free space is on a page (in per cent) should be reserved for formation of a new page or a new column.
boolean	getNewColumnAfter() If the value of this property is true, then, after output of a band, a new column will be generated.
boolean	getNewColumnBefore() If the value of this property is true, then, before output of a band, a new column will be generated.
boolean	getNewPageAfter() If the value of this property is true, then, after output of a band, a new page will be generated.
boolean	getNewPageBefore() If the value of this property is true, then, before output of a band, a new page will be generated.
boolean	getPrintAtBottom() Gets or sets value indicates that the footer is printed at bottom of page.
boolean	getSkipFirst() If the value of this property is true, then, a new page/column will be generated only starting from the second case.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setBreakIfLessThan(float value)
void	setCanBreak(boolean value) Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
void	setNewColumnAfter(boolean value)
void	setNewColumnBefore(boolean value)
void	setNewPageAfter(boolean value)
void	setNewPageBefore(boolean value)
void	setPrintAtBottom(boolean value)
void	setSkipFirst(boolean value)

Methods inherited from class com.stimulsoft.report.components.bands.StiBand

canContainIn, clone, getBandInfoV2, getCanGrow, getComponentType, getDefaultClientRectangle, getDisplayRectangle, getDockStyle, getFooterSize, getGrowToHeight, getHeaderEndColor, getHeaderSize, getHeaderStartColor, GetHeaderText, getLeft, getLocalizedCategory, getMaxHeight, getMaxSize, getMinHeight, getMinSize, getNestedLevel, getPrintable, getQuickInfo, getRectangleMoveComponent, getResetPageNumber, getSelectRectangle, getShiftMode, getTop, getWidth, isAutomaticDock, setCanGrow, setDirectDisplayRectangle, setDisplayRectangle, setDockStyle, setGrowToHeight, setLeft, setMaxHeight, setMaxSize, setMinHeight, setMinSize, setPrintable, setRectangleMoveComponent, setResetPageNumber, setSelectRectangle, setShiftMode, setTop, setWidth

Methods inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer

AlignTo, AlignToGrid, AlignToGrid, BringToFront, ChangePosition, checkBlockedException, CheckBlockedException, checkLargeHeight, ClearAllStates, clone, ContainerToPage, ContainerToPage, convert, Convert, ConvertSelectedToPage, ConvertToPage, Correct, Correct, correct2, getActualSize, getActualSize, getBlocked, getBorder, GetBorder, getBrush, GetBrush, getCanBreak, getClientRectangle, getCollapsedValue, getCollapsingIndex, getCollapsingTreePath, getComponentPlacementForChildren, getComponents, GetComponents, GetComponentsCount, GetComponentsList, getComponentsSelectedRectangle, getComponentStyle, GetConditions, getContainerInfoV1, getContainerInfoV2, GetContainerInRect, GetContainerInRect2, GetDockableComponent, GetDockStyle, GetFirstSelectableCompanent, GetFont, getGuid, getHasSelected, GetHorAlignment, GetIncorrect, GetIncorrect, getIncorrect2, getLocalizedName, GetMaxSize, getName, getPriority, GetRectangle, GetSelectedComponents, GetSelectedComponentsWithChilds, GetSelectedRectangleWithChilds, getTagValue, GetTextBrush, GetTextFormat, GetTextHorAlignment, getToolboxPosition, GetVertAlignment, GetWordWrap, GrowFont, InvertComponentsPosition, isForceSerializeToReport, MakeHorizontalSpacingEqual, MakeSameHeight, MakeSameSize, MakeSameWidth, MakeVerticalSpacingEqual, MoveBackward, MoveComponentsToPage, MoveForward, Normalize, OffsetLocation, OnComponentAdded, OnComponentRemoved, PageToContainer, PageToContainer, RemoveAllSelected, ResetSelection, RestoreState, saveState, SelectAll, SelectComponent, SelectInRectangle, SelectInRectangleCheckBands, SendToBack, setBlocked, setBorder, SetBorder, setBrush, SetBrush, SetCenterHorizontally, SetCenterVertically, setCollapsedValue, setCollapsingIndex, setCollapsingTreePath, setComponents, setComponentsFont, setComponentsFont, setComponentsWithSetParent, setComponentsWordWrap, SetConditions, setContainerInfoV2, SetDockStyle, setForceSerializeToReport, SetHorAlign, SetLink, setParentComponentIsBand, setParentComponentIsCrossBand, SetParentStylesToChilds, SetParentStylesToChilds, SetTextBrush, SetTextFormat, SetTextHorAlign, SetVertAlign, ShrinkFont, SortByPriority

Methods inherited from class com.stimulsoft.report.components.StiComponent

addSize, AllowPrintOn, applyConditions, CheckForParentComponent, clearAllStates, ClearContents, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, fillComponentPlacement, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getBuilder, getCanShrink, getClickEvent, getComponentPlacement, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDoubleClickEvent, getDrillDownParameters, getEnabled, getEvents, getForceRedrawAll, getgetBookmarkEvent, getgetDrillDownReportEvent, getgetHyperlinkEvent, getgetTagEvent, getgetToolTipEvent, getGroupHeaderBand, GetGroupHeaderBand, getHeight, getHighlightState, getHyperlink, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInteraction, getInvalidateOnMouseOver, getIsCross, getIsDesigning, getIsEnabled, getIsEventEmpty, getIsExporting, getIsgetTagHandlerEmpty, getIsPrinting, getIsRendered, getIsSelected, getLevel, getLinked, getLocked, getMeasureGraphics, getMouseEnterEvent, getMouseLeaveEvent, getPage, getPaintRectangle, getPaintRectangle, getPaintRectangle, getParent, getParentBookmark, getPlaceOnToolbox, getPrintOn, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getServiceCategory, getServiceType, getShift, getShowQuickButtons, getStates, getTag, getToolTip, getToolTipValue, getUseParentStyles, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, InvokeClick, InvokeDoubleClick, InvokeEndRender, invokeEvents, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, isDesigning, isExportAsImage, IsParentSelect, NewGuid, OnAfterPrint, OnBeforePrint, OnClick, OnDoubleClick, OngetBookmark, OngetDrillDownReport, OngetHyperlink, OngetTag, OngetToolTip, OnMouseEnter, OnMouseLeave, OnPainted, OnPainting, OnRemoveComponent, packService, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, select, setAfterPrintEvent, setAlias, setAnchor, setBeforePrintEvent, setBookmark, setBookmarkValue, setCanShrink, setClickEvent, setClientRectangle, setComponentPlacement, setComponentStyle, setConditions, setCurrentBookmark, setDelimiterComponent, setDockable, setDoubleClickEvent, setDrillDownParameters, setEnabled, setgetBookmarkEvent, setgetDrillDownReportEvent, setgetHyperlinkEvent, setgetTagEvent, setgetToolTipEvent, setGuid, setHeight, setHeightProp, setHighlightState, setHyperlink, setHyperlinkValue, setIgnoreNamingRule, setInherited, setInteraction, setIsRendered, setIsSelected, setLeftProp, setLinked, setLocked, setMouseEnterEvent, setMouseLeaveEvent, setName, setPage, setPaintRectangle, setParent, setParentBookmark, setPlaceOnToolbox, setPrintOn, setRenderedCount, setReport, SetReportVariables, setRestrictions, setSelectionTick, setShift, setShowQuickButtons, setStates, setTag, setTagValue, setToolTip, setToolTipValue, setTopProp, setUseParentStyles, setWidthProp, toString, UnPrepare

Methods inherited from class com.stimulsoft.report.StiBase

getServiceName

Methods inherited from class com.stimulsoft.base.services.StiService

getProperties, getServiceEnabled, getServiceInfo, isPropertyPresent, MemberwiseClone, properties, setProperties, setServiceEnabled

Methods inherited from class com.stimulsoft.base.serializing.StiSerializedObject

cleanReference, getReference, setReference

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.stimulsoft.report.components.interfaces.IStiBreakable

getCanBreak

Methods inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

getReference, setReference

Constructor Detail

StiDynamicBand

public StiDynamicBand()

Creates a new dynamic band.

StiDynamicBand

public StiDynamicBand(StiRectangle rect)

Creates a new dynamic band.

Parameters:

rect - The rectangle describes size and position of the component.

Method Detail

getPrintAtBottom

public boolean getPrintAtBottom()

Gets or sets value indicates that the footer is printed at bottom of page.

Specified by:

getPrintAtBottom in interface IStiPrintAtBottom

setPrintAtBottom

public void setPrintAtBottom(boolean value)

Specified by:

setPrintAtBottom in interface IStiPrintAtBottom

setCanBreak

public void setCanBreak(boolean value)

Gets or sets value which indicates whether the component can or cannot break its contents on several pages.

Specified by:

setCanBreak in interface IStiBreakable

Overrides:

setCanBreak in class StiContainer

Break

public boolean Break(StiComponent dividedComponent,
            double devideFactor,
            StiRefObject<java.lang.Double> divLine)

Divides content of components in two parts. Returns result of dividing. If true, then component is successful divided.

Specified by:

Break in interface IStiBreakable

Overrides:

Break in class StiContainer

Parameters:

dividedComponent - Component for store part of content.

Returns:

If true, then component is successful divided.

getNewPageBefore

public boolean getNewPageBefore()

If the value of this property is true, then, before output of a band, a new page will be generated. Output of a band will be continued on the next page.

Specified by:

getNewPageBefore in interface IStiPageBreak

setNewPageBefore

public void setNewPageBefore(boolean value)

Specified by:

setNewPageBefore in interface IStiPageBreak

getNewPageAfter

public boolean getNewPageAfter()

If the value of this property is true, then, after output of a band, a new page will be generated.

Specified by:

getNewPageAfter in interface IStiPageBreak

setNewPageAfter

public void setNewPageAfter(boolean value)

Specified by:

setNewPageAfter in interface IStiPageBreak

getNewColumnBefore

public boolean getNewColumnBefore()

If the value of this property is true, then, before output of a band, a new column will be generated. Output of a band will be continued on the next column.

Specified by:

getNewColumnBefore in interface IStiPageBreak

setNewColumnBefore

public void setNewColumnBefore(boolean value)

Specified by:

setNewColumnBefore in interface IStiPageBreak

getNewColumnAfter

public boolean getNewColumnAfter()

If the value of this property is true, then, after output of a band, a new column will be generated.

Specified by:

getNewColumnAfter in interface IStiPageBreak

setNewColumnAfter

public void setNewColumnAfter(boolean value)

Specified by:

setNewColumnAfter in interface IStiPageBreak

getSkipFirst

public boolean getSkipFirst()

If the value of this property is true, then, a new page/column will be generated only starting from the second case.

Specified by:

getSkipFirst in interface IStiPageBreak

setSkipFirst

public void setSkipFirst(boolean value)

Specified by:

setSkipFirst in interface IStiPageBreak

getBreakIfLessThan

public float getBreakIfLessThan()

Gets or sets value which indicates how much free space is on a page (in per cent) should be reserved for formation of a new page or a new column. The value should be set in the range from 0 to 100. If the value is 100 then, in any case, a new page or a new column will be formed. This property is used together with NewPageBefore, NewPageAfter, NewColumnBefore, NewColumnAfter properties.

Specified by:

getBreakIfLessThan in interface IStiPageBreak

setBreakIfLessThan

public void setBreakIfLessThan(float value)

Specified by:

setBreakIfLessThan in interface IStiPageBreak

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiBand

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiBand

Throws:

JSONException