com.stimulsoft.report.components.crossBands

Class StiCrossGroupFooterBand

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

com.stimulsoft.report.components.bands.StiGroupFooterBand

com.stimulsoft.report.components.crossBands.StiCrossGroupFooterBand

All Implemented Interfaces:

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

public class StiCrossGroupFooterBand
extends StiGroupFooterBand

Class describes Cross Group Footer Band.

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
StiCrossGroupFooterBand() Creates a new component of the type StiCrossGroupFooterBand.
StiCrossGroupFooterBand(StiRectangle rect) Creates a new component of the type StiCrossGroupFooterBand with the specified location.

Method Summary

Methods

Modifier and Type	Method and Description
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	getCanBreak() Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
StiRectangle	getDefaultClientRectangle() Gets or sets the default client area of a component.
StiRectangle	getDisplayRectangle() Gets or sets a rectangle of the component which it fills.
StiDockStyle	getDockStyle() Gets or sets a type of the component docking.
boolean	getGrowToHeight() gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.
double	getHeaderSize() Gets the header height.
double	getHeight()
boolean	getIsCross() Gets value, indicates that this cross is the component.
java.lang.String	getLocalizedCategory() Gets a localized name of the component category.
java.lang.String	getLocalizedName() Gets a localized component name.
double	getMaxHeight() Gets or sets maximal height of band.
StiSize	getMaxSize() gets or sets maximal size.
double	getMaxWidth() Gets or sets maximal width of band.
double	getMinHeight() Gets or sets minimal height of band.
StiSize	getMinSize() gets or sets minimal size.
double	getMinWidth() Gets or sets minimal width of band.
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.
int	getPriority() Gets a component priority.
boolean	getResetPageNumber() Allows to reset page number on this band.
StiRectangle	getSelectRectangle() Gets or sets a rectangle of the component selection.
boolean	getSkipFirst() If the value of this property is true, then, a new page/column will be generated only starting from the second case.
int	getToolboxPosition() Gets value to sort a position in the toolbox.
double	getWidth() gets or sets width of a component.
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	setDisplayRectangle(StiRectangle value)
void	setDockStyle(StiDockStyle value)
void	setGrowToHeight(boolean value)
void	setHeight(double value)
void	setMaxHeight(double value)
void	setMaxSize(StiSize value)
void	setMaxWidth(double value)
void	setMinHeight(double value)
void	setMinSize(StiSize value)
void	setMinWidth(double value)
void	setNewColumnAfter(boolean value)
void	setNewColumnBefore(boolean value)
void	setNewPageAfter(boolean value)
void	setNewPageBefore(boolean value)
void	setPrintAtBottom(boolean value)
void	setResetPageNumber(boolean value)
void	setSelectRectangle(StiRectangle value) Returns the GroupHeaderBand in which the component is loc * null, if nothing is located.
void	setSkipFirst(boolean value)
void	setWidth(double value)

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

clone, getComponentType, getGroupFooterBandInfoV2, getHeaderEndColor, getHeaderStartColor, getKeepGroupFooterTogether, getLine, setKeepGroupFooterTogether

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

Break

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

canContainIn, getBandInfoV2, getCanGrow, getFooterSize, GetHeaderText, getLeft, getNestedLevel, getPrintable, getQuickInfo, getRectangleMoveComponent, getShiftMode, getTop, isAutomaticDock, setCanGrow, setDirectDisplayRectangle, setLeft, setPrintable, setRectangleMoveComponent, setShiftMode, setTop

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, 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, GetMaxSize, getName, GetRectangle, GetSelectedComponents, GetSelectedComponentsWithChilds, GetSelectedRectangleWithChilds, getTagValue, GetTextBrush, GetTextFormat, GetTextHorAlignment, 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, getHighlightState, getHyperlink, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInteraction, getInvalidateOnMouseOver, 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, 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.base.serializing.interfaceobject.IStiSerializableRef

getReference, setReference

Constructor Detail

StiCrossGroupFooterBand

public StiCrossGroupFooterBand()

Creates a new component of the type StiCrossGroupFooterBand.

StiCrossGroupFooterBand

public StiCrossGroupFooterBand(StiRectangle rect)

Creates a new component of the type StiCrossGroupFooterBand with the specified location.

Parameters:

rect - The rectangle describes sizes and positions of the component.

Method Detail

getNewPageBefore

public boolean getNewPageBefore()

Description copied from class: StiDynamicBand

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

Overrides:

getNewPageBefore in class StiDynamicBand

setNewPageBefore

public void setNewPageBefore(boolean value)

Specified by:

setNewPageBefore in interface IStiPageBreak

Overrides:

setNewPageBefore in class StiDynamicBand

getNewPageAfter

public boolean getNewPageAfter()

Description copied from class: StiDynamicBand

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

Overrides:

getNewPageAfter in class StiDynamicBand

setNewPageAfter

public void setNewPageAfter(boolean value)

Specified by:

setNewPageAfter in interface IStiPageBreak

Overrides:

setNewPageAfter in class StiDynamicBand

getNewColumnBefore

public boolean getNewColumnBefore()

Description copied from class: StiDynamicBand

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

Overrides:

getNewColumnBefore in class StiDynamicBand

setNewColumnBefore

public void setNewColumnBefore(boolean value)

Specified by:

setNewColumnBefore in interface IStiPageBreak

Overrides:

setNewColumnBefore in class StiDynamicBand

getNewColumnAfter

public boolean getNewColumnAfter()

Description copied from class: StiDynamicBand

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

Overrides:

getNewColumnAfter in class StiDynamicBand

setNewColumnAfter

public void setNewColumnAfter(boolean value)

Specified by:

setNewColumnAfter in interface IStiPageBreak

Overrides:

setNewColumnAfter in class StiDynamicBand

getSkipFirst

public boolean getSkipFirst()

Description copied from class: StiDynamicBand

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

Overrides:

getSkipFirst in class StiDynamicBand

setSkipFirst

public void setSkipFirst(boolean value)

Specified by:

setSkipFirst in interface IStiPageBreak

Overrides:

setSkipFirst in class StiDynamicBand

getBreakIfLessThan

public float getBreakIfLessThan()

Description copied from class: StiDynamicBand

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

Overrides:

getBreakIfLessThan in class StiDynamicBand

setBreakIfLessThan

public void setBreakIfLessThan(float value)

Specified by:

setBreakIfLessThan in interface IStiPageBreak

Overrides:

setBreakIfLessThan in class StiDynamicBand

getGrowToHeight

public boolean getGrowToHeight()

Description copied from class: StiComponent

gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.

Specified by:

getGrowToHeight in interface IStiGrowToHeight

Overrides:

getGrowToHeight in class StiBand

setGrowToHeight

public void setGrowToHeight(boolean value)

Specified by:

setGrowToHeight in interface IStiGrowToHeight

Overrides:

setGrowToHeight in class StiBand

getResetPageNumber

public boolean getResetPageNumber()

Description copied from class: StiBand

Allows to reset page number on this band.

Specified by:

getResetPageNumber in interface IStiResetPageNumber

Overrides:

getResetPageNumber in class StiBand

setResetPageNumber

public void setResetPageNumber(boolean value)

Specified by:

setResetPageNumber in interface IStiResetPageNumber

Overrides:

setResetPageNumber in class StiBand

getPrintAtBottom

public boolean getPrintAtBottom()

Description copied from class: StiDynamicBand

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

Specified by:

getPrintAtBottom in interface IStiPrintAtBottom

Overrides:

getPrintAtBottom in class StiDynamicBand

setPrintAtBottom

public void setPrintAtBottom(boolean value)

Specified by:

setPrintAtBottom in interface IStiPrintAtBottom

Overrides:

setPrintAtBottom in class StiDynamicBand

getCanBreak

public boolean getCanBreak()

Description copied from class: StiContainer

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

Specified by:

getCanBreak in interface IStiBreakable

Overrides:

getCanBreak in class StiContainer

setCanBreak

public void setCanBreak(boolean value)

Description copied from class: StiDynamicBand

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 StiDynamicBand

getToolboxPosition

public int getToolboxPosition()

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiGroupFooterBand

getLocalizedCategory

public java.lang.String getLocalizedCategory()

Gets a localized name of the component category.

Overrides:

getLocalizedCategory in class StiBand

getLocalizedName

public java.lang.String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiGroupFooterBand

getIsCross

public boolean getIsCross()

Gets value, indicates that this cross is the component.

Overrides:

getIsCross in class StiComponent

getPriority

public int getPriority()

Gets a component priority.

Overrides:

getPriority in class StiGroupFooterBand

getDockStyle

public StiDockStyle getDockStyle()

Gets or sets a type of the component docking.

Overrides:

getDockStyle in class StiBand

setDockStyle

public void setDockStyle(StiDockStyle value)

Overrides:

setDockStyle in class StiBand

getMinSize

public StiSize getMinSize()

Description copied from class: StiComponent

gets or sets minimal size.

Overrides:

getMinSize in class StiBand

setMinSize

public void setMinSize(StiSize value)

Overrides:

setMinSize in class StiBand

getMaxSize

public StiSize getMaxSize()

Description copied from class: StiComponent

gets or sets maximal size.

Overrides:

getMaxSize in class StiBand

setMaxSize

public void setMaxSize(StiSize value)

Overrides:

setMaxSize in class StiBand

getMaxHeight

public double getMaxHeight()

Description copied from class: StiBand

Gets or sets maximal height of band.

Overrides:

getMaxHeight in class StiBand

setMaxHeight

public void setMaxHeight(double value)

Overrides:

setMaxHeight in class StiBand

getMinHeight

public double getMinHeight()

Description copied from class: StiBand

Gets or sets minimal height of band.

Overrides:

getMinHeight in class StiBand

setMinHeight

public void setMinHeight(double value)

Overrides:

setMinHeight in class StiBand

getMinWidth

public double getMinWidth()

Gets or sets minimal width of band.

setMinWidth

public void setMinWidth(double value)

getMaxWidth

public double getMaxWidth()

Gets or sets maximal width of band.

setMaxWidth

public void setMaxWidth(double value)

getWidth

public double getWidth()

Description copied from class: StiComponent

gets or sets width of a component.

Overrides:

getWidth in class StiBand

setWidth

public void setWidth(double value)

Overrides:

setWidth in class StiBand

getHeight

public double getHeight()

Overrides:

getHeight in class StiComponent

setHeight

public void setHeight(double value)

Overrides:

setHeight in class StiComponent

getDefaultClientRectangle

public StiRectangle getDefaultClientRectangle()

Gets or sets the default client area of a component.

Overrides:

getDefaultClientRectangle in class StiBand

getSelectRectangle

public StiRectangle getSelectRectangle()

Gets or sets a rectangle of the component selection.

Overrides:

getSelectRectangle in class StiBand

setSelectRectangle

public void setSelectRectangle(StiRectangle value)

Description copied from class: StiComponent

Returns the GroupHeaderBand in which the component is loc * null, if nothing is located.

Overrides:

setSelectRectangle in class StiBand

getDisplayRectangle

public StiRectangle getDisplayRectangle()

Gets or sets a rectangle of the component which it fills. Docking occurs in accordance to the area (Cross - components are docked by ClientRectangle).

Overrides:

getDisplayRectangle in class StiBand

setDisplayRectangle

public void setDisplayRectangle(StiRectangle value)

Overrides:

setDisplayRectangle in class StiBand

getHeaderSize

public double getHeaderSize()

Gets the header height.

Overrides:

getHeaderSize in class StiBand

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiGroupFooterBand

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiGroupFooterBand

Throws:

JSONException