Package com.stimulsoft.report.components.bands

Class StiBand

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

All Implemented Interfaces:

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

Direct Known Subclasses:

StiDynamicBand, StiEmptyBand, StiStaticBand

public abstract class StiBand
extends StiContainer
implements IStiResetPageNumber

Describes the base class for bands.

Field Summary

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

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

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

canGrow, canShrink, componentPlacement, conditions, currentPointer, eventFlags, expressions, interaction, isRendered, page, parent, parentBookmark, parentPointer, 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	Description
StiBand()	Creates a new band.
StiBand(StiRectangle rect)	Creates a new band.

Method Summary

Modifier and Type	Method	Description
boolean	canContainIn(StiComponent component)	May this container be located : the specified component.
Object	clone(boolean cloneProperties, boolean cloneComponents)	Creates a new object that instanceof a copy of the current instance.
final StiBandInfoV2	getBandInfoV2()
boolean	getCanGrow()	Gets or sets value indicates that this object can grow.
StiComponentType	getComponentType()	Gets the type of processing when printing.
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.
double	getFooterSize()	Gets the footer height.
boolean	getGrowToHeight()	gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.
abstract StiColor	getHeaderEndColor()	Gets header end color.
double	getHeaderSize()	Gets the header height.
abstract StiColor	getHeaderStartColor()	Gets header start color.
String	GetHeaderText()	Returns the band header text.
double	getLeft()	gets or sets left position of a component.
String	getLocalizedCategory()	Gets a localized name of the component category.
double	getMaxHeight()	Gets or sets maximal height of band.
StiSize	getMaxSize()	gets or sets maximal size.
double	getMinHeight()	Gets or sets minimal height of band.
StiSize	getMinSize()	gets or sets minimal size.
int	getNestedLevel()	Gets nested level of this band.
boolean	getPrintable()	gets or sets a value which indicates whether a component is printable or not.
String	getQuickInfo()
final StiRectangle	getRectangleMoveComponent()
boolean	getResetPageNumber()	Allows to reset page number on this band.
StiRectangle	getSelectRectangle()	Gets or sets a rectangle of the component selection.
StiEnumSet<StiShiftMode>	getShiftMode()	gets or sets a value which indicates the shift mode of a component.
double	getTop()	gets or sets top position of a component.
double	getWidth()	gets or sets width of a component.
boolean	isAutomaticDock()	Gets value indicates that this instanceof an automatic docking.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setCanGrow(boolean value)
void	setDirectDisplayRectangle(StiRectangle rect)
void	setDisplayRectangle(StiRectangle value)
void	setDockStyle(StiDockStyle value)
void	setGrowToHeight(boolean value)
void	setLeft(double value)
void	setMaxHeight(double value)
void	setMaxSize(StiSize value)
void	setMinHeight(double value)
void	setMinSize(StiSize value)
void	setPrintable(boolean value)
final void	setRectangleMoveComponent(StiRectangle value)
void	setResetPageNumber(boolean value)
void	setSelectRectangle(StiRectangle value)	Returns the GroupHeaderBand in which the component is loc * null, if nothing is located.
void	setShiftMode(StiEnumSet<StiShiftMode> value)
void	setTop(double value)
void	setWidth(double value)

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

AlignTo, AlignToGrid, AlignToGrid, Break, 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, setCanBreak, 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, doPointer, doPointer, fillComponentPlacement, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getBuilder, getCanShrink, getClickEvent, getComponentPlacement, GetComponentStyle, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDoubleClickEvent, getDrillDownParameters, getEnabled, getEvents, getExpressions, 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, getPointer, getPointerValue, getPrintOn, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getServiceCategory, getServiceType, getShift, getShowQuickButtons, getStates, getTag, getTagStrValue, getToolTip, getToolTipValue, getUseParentStyles, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, invokeBlockly, InvokeClick, InvokeDoubleClick, InvokeEndRender, invokeEvents, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, invokeScript, invokeScript, invokeScript, 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, setExpressions, 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, setPointer, setPointerValue, 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 Details

StiBand

public StiBand()

Creates a new band.

StiBand

public StiBand(StiRectangle rect)

Creates a new band.

Parameters:

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

Method Details

getResetPageNumber

public boolean getResetPageNumber()

Allows to reset page number on this band.

Specified by:

getResetPageNumber in interface IStiResetPageNumber

setResetPageNumber

public void setResetPageNumber(boolean value)

Specified by:

setResetPageNumber in interface IStiResetPageNumber

getCanGrow

public boolean getCanGrow()

Gets or sets value indicates that this object can grow.

Specified by:

getCanGrow in interface IStiCanGrow

Overrides:

getCanGrow in class StiComponent

setCanGrow

public void setCanGrow(boolean value)

Specified by:

setCanGrow in interface IStiCanGrow

Overrides:

setCanGrow in class StiComponent

getQuickInfo

public String getQuickInfo()

Overrides:

getQuickInfo in class StiComponent

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 StiComponent

setGrowToHeight

public void setGrowToHeight(boolean value)

Specified by:

setGrowToHeight in interface IStiGrowToHeight

Overrides:

setGrowToHeight in class StiComponent

getShiftMode

public StiEnumSet<StiShiftMode> getShiftMode()

Description copied from class: StiComponent

gets or sets a value which indicates the shift mode of a component.

Specified by:

getShiftMode in interface IStiShift

Overrides:

getShiftMode in class StiComponent

setShiftMode

public void setShiftMode(StiEnumSet<StiShiftMode> value)

Specified by:

setShiftMode in interface IStiShift

Overrides:

setShiftMode in class StiComponent

canContainIn

public boolean canContainIn(StiComponent component)

May this container be located : the specified component.

Overrides:

canContainIn in class StiComponent

Parameters:

component - Component for checking.

Returns:

true, if this container may instanceof located : the specified component.

getLocalizedCategory

public String getLocalizedCategory()

Gets a localized name of the component category.

Overrides:

getLocalizedCategory in class StiContainer

getComponentType

public StiComponentType getComponentType()

Gets the type of processing when printing.

Overrides:

getComponentType in class StiContainer

getBandInfoV2

public final StiBandInfoV2 getBandInfoV2()

getPrintable

public boolean getPrintable()

Description copied from class: StiComponent

gets or sets a value which indicates whether a component is printable or not.

Overrides:

getPrintable in class StiComponent

setPrintable

public void setPrintable(boolean value)

Overrides:

setPrintable in class StiComponent

getDockStyle

public StiDockStyle getDockStyle()

Gets or sets a type of the component docking.

Overrides:

getDockStyle in class StiComponent

setDockStyle

public void setDockStyle(StiDockStyle value)

Overrides:

setDockStyle in class StiComponent

isAutomaticDock

public boolean isAutomaticDock()

Gets value indicates that this instanceof an automatic docking.

Overrides:

isAutomaticDock in class StiComponent

getMinSize

public StiSize getMinSize()

Description copied from class: StiComponent

gets or sets minimal size.

Overrides:

getMinSize in class StiComponent

setMinSize

public void setMinSize(StiSize value)

Overrides:

setMinSize in class StiComponent

getMaxSize

public StiSize getMaxSize()

Description copied from class: StiComponent

gets or sets maximal size.

Overrides:

getMaxSize in class StiComponent

setMaxSize

public void setMaxSize(StiSize value)

Overrides:

setMaxSize in class StiComponent

getMinHeight

public double getMinHeight()

Gets or sets minimal height of band.

setMinHeight

public void setMinHeight(double value)

getMaxHeight

public double getMaxHeight()

Gets or sets maximal height of band.

setMaxHeight

public void setMaxHeight(double value)

getLeft

public double getLeft()

Description copied from class: StiComponent

gets or sets left position of a component.

Overrides:

getLeft in class StiComponent

setLeft

public void setLeft(double value)

Overrides:

setLeft in class StiComponent

getTop

public double getTop()

Description copied from class: StiComponent

gets or sets top position of a component.

Overrides:

getTop in class StiComponent

setTop

public void setTop(double value)

Overrides:

setTop in class StiComponent

getWidth

public double getWidth()

Description copied from class: StiComponent

gets or sets width of a component.

Overrides:

getWidth in class StiComponent

setWidth

public void setWidth(double value)

Overrides:

setWidth in class StiComponent

getDefaultClientRectangle

public StiRectangle getDefaultClientRectangle()

Gets or sets the default client area of a component.

Overrides:

getDefaultClientRectangle in class StiContainer

getDisplayRectangle

public StiRectangle getDisplayRectangle()

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

Overrides:

getDisplayRectangle in class StiComponent

setDisplayRectangle

public void setDisplayRectangle(StiRectangle value)

Overrides:

setDisplayRectangle in class StiComponent

setDirectDisplayRectangle

public void setDirectDisplayRectangle(StiRectangle rect)

Overrides:

setDirectDisplayRectangle in class StiComponent

getSelectRectangle

public StiRectangle getSelectRectangle()

Gets or sets a rectangle of the component selection.

Overrides:

getSelectRectangle in class StiComponent

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 StiComponent

getRectangleMoveComponent

public final StiRectangle getRectangleMoveComponent()

setRectangleMoveComponent

public final void setRectangleMoveComponent(StiRectangle value)

GetHeaderText

public String GetHeaderText()

Returns the band header text.

Returns:

Band header text.

getHeaderStartColor

public abstract StiColor getHeaderStartColor()

Gets header start color.

getHeaderEndColor

public abstract StiColor getHeaderEndColor()

Gets header end color.

getHeaderSize

public double getHeaderSize()

Gets the header height.

getFooterSize

public double getFooterSize()

Gets the footer height.

getNestedLevel

public int getNestedLevel()

Gets nested level of this band.

Returns:

clone

public Object clone(boolean cloneProperties,
 boolean cloneComponents)

Description copied from class: StiContainer

Creates a new object that instanceof a copy of the current instance.

Overrides:

clone in class StiContainer

Returns:

A new object that instanceof a copy of this instance.

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiContainer

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiContainer

Throws:

JSONException