Package com.stimulsoft.report.components.bands

Class StiHierarchicalBand

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.StiDataBand

com.stimulsoft.report.components.bands.StiHierarchicalBand

All Implemented Interfaces:

IStiAppExpressionCollection, IStiJsonReportObject, IStiForceSerializable, IStiSerializable, IStiSerializableRef, IStiSerializableToAttributes, IStiName, IStiBorder, IStiBreakable, IStiBrush, IStiBusinessObject, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiDataRelation, IStiDataSource, IStiFilter, IStiGrowToHeight, IStiInteraction, IStiKeepDetailsTogether, IStiKeepFooterTogether, IStiKeepGroupTogether, IStiKeepHeaderTogether, IStiMasterComponent, IStiOddEvenStyles, IStiPageBreak, IStiPrintAtBottom, IStiPrintIfDetailEmpty, IStiPrintOn, IStiPrintOnAllPages, IStiRenderMaster, IStiResetPageNumber, IStiSelect, IStiShift, IStiSort, IStiStartNewPage, IStiUnitConvert, IStiEnumerator, IStiReportProperty, IStiIgnoryStyle, IStiInherited, IStiStateSaveRestore, Cloneable

public class StiHierarchicalBand
extends StiDataBand

Describes the class that realizes a Hierarchical Band.

Field Summary

Fields inherited from class com.stimulsoft.report.components.bands.StiDataBand

handlerRendering, isBofValue, isEofValue, jsonMasterComponentTemp, lineThrough, PropertyEvenStyle, PropertyOddStyle

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, 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
StiHierarchicalBand()	Creates an object of the type StiHierarchicalBand.
StiHierarchicalBand(StiRectangle rect)	Creates an object of the type StiHierarchicalBand.

Method Summary

Modifier and Type	Method	Description
protected StiV2Builder	getBuilder()
StiBusinessObject	getBusinessObject()	Get business object that is used for getting data.
final String	getFooters()	Gets or sets the list of footers for the hierarchical band.
StiColor	getHeaderEndColor()	Gets header end color.
final String	getHeaders()	Gets or sets the list of headers for the hierarchical band.
StiColor	getHeaderStartColor()	Gets header start color.
final StiHierarchicalBandInfoV2	getHierarchicalBandInfoV2()
double	getIndent()	Gets or sets indent from the left side of band for offset of data levels.
final String	getKeyDataColumn()	Gets or sets column which contains data key.
String	getLocalizedName()	Gets a localized component name.
final String	getMasterKeyDataColumn()	Gets or sets column which contains data master key.
final String	getParentValue()	Gets or sets column which contains parent value which identifies parent rows.
int	getToolboxPosition()	Gets value to sort a position in the toolbox.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
final void	setFooters(String value)
final void	setHeaders(String value)
void	setIndent(double value)
final void	setKeyDataColumn(String value)
final void	setMasterKeyDataColumn(String value)
final void	setParentValue(String value)

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

clone, convert, doBookmark, doPointer, existDataRelation, First, getBeginRenderEvent, getBusinessObjectGuid, getCalcInvisible, getCollapsed, getColumnDirection, getColumnGaps, getColumns, getColumnWidth, GetColumnWidth, getComponentPlacementForChildren, getComponentType, getCount, getCountData, getDataBandInfoV1, getDataBandInfoV2, getDataRelation, getDataRelationName, getDataSource, getDataSourceName, getEndRenderEvent, getEvenStyle, getEvents, getFilterEngine, getFilterMethodHandler, getFilterMode, getFilterOn, getFilters, getGetCollapsedEvent, GetHeaderText, getIsBof, getIsBusinessObjectEmpty, getIsEmpty, getIsEof, getKeepChildTogether, getKeepDetails, getKeepDetailsTogether, getKeepFooterTogether, getKeepGroupTogether, getKeepHeaderTogether, getLimitRows, getLine, getLineThrough, getMasterComponent, getMinRowsInColumn, getOddStyle, getPageLine, getPosition, getPrintIfDetailEmpty, getPrintOnAllPages, getPriority, getRenderingEvent, getResetDataSource, getResetPageNumber, getRightToLeft, getSelectedLine, getSort, getStartNewPage, getStartNewPageIfLessThan, InvokeBeginRender, InvokeEndRender, InvokeGetCollapsed, InvokeGroupRendering, InvokeRendering, isDataSourceEmpty, Last, Next, OnBeginRender, OnEndRender, OnGetCollapsed, OnRendering, packService, Prior, renderMaster, RestoreState, saveState, setBeginRenderEvent, setBusinessObjectGuid, setCalcInvisible, setCollapsed, setColumnDirection, setColumnGaps, setColumns, setColumnWidth, setCountData, setDataRelationName, setDataSourceName, setEndRenderEvent, setEvenStyle, setFilterEngine, setFilterMethodHandler, setFilterMode, setFilterOn, setFilters, setGetCollapsedEvent, setIsBof, setIsEof, setKeepChildTogether, setKeepDetails, setKeepDetailsTogether, setKeepFooterTogether, setKeepGroupTogether, setKeepHeaderTogether, setLimitRows, setLine, setLineThrough, setMasterComponent, setMinRowsInColumn, setOddStyle, setPosition, setPrintIfDetailEmpty, setPrintOnAllPages, setRenderingEvent, setResetDataSource, setResetPageNumber, setRightToLeft, setSelectedLine, setSort, setStartNewPage, setStartNewPageIfLessThan

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

Break, getBreakIfLessThan, getNewColumnAfter, getNewColumnBefore, getNewPageAfter, getNewPageBefore, getPrintAtBottom, getSkipFirst, setBreakIfLessThan, setCanBreak, setNewColumnAfter, setNewColumnBefore, setNewPageAfter, setNewPageBefore, setPrintAtBottom, setSkipFirst

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

canContainIn, getBandInfoV2, getCanGrow, getDefaultClientRectangle, getDisplayRectangle, getDockStyle, getFooterSize, getGrowToHeight, getHeaderSize, getLeft, getLocalizedCategory, getMaxHeight, getMaxSize, getMinHeight, getMinSize, getNestedLevel, getPrintable, getQuickInfo, getRectangleMoveComponent, getSelectRectangle, getShiftMode, getTop, getWidth, isAutomaticDock, setCanGrow, setDirectDisplayRectangle, setDisplayRectangle, setDockStyle, setGrowToHeight, setLeft, setMaxHeight, setMaxSize, setMinHeight, setMinSize, setPrintable, setRectangleMoveComponent, 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, ConvertSelectedToPage, ConvertToPage, Correct, Correct, correct2, getActualSize, getActualSize, getBlocked, getBorder, GetBorder, getBrush, GetBrush, getCanBreak, getClientRectangle, getCollapsedValue, getCollapsingIndex, getCollapsingTreePath, 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, 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, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, fillComponentPlacement, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getCanShrink, getClickEvent, getComponentPlacement, GetComponentStyle, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDoubleClickEvent, getDrillDownParameters, getEnabled, 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, invokeBlockly, InvokeClick, InvokeDoubleClick, 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, 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.report.components.interfaces.IStiBreakable

getCanBreak

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

getReference, setReference

Constructor Details

StiHierarchicalBand

public StiHierarchicalBand()

Creates an object of the type StiHierarchicalBand.

StiHierarchicalBand

public StiHierarchicalBand(StiRectangle rect)

Creates an object of the type StiHierarchicalBand.

Parameters:

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

Method Details

getToolboxPosition

public int getToolboxPosition()

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiDataBand

getLocalizedName

public String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiDataBand

getHeaderStartColor

public StiColor getHeaderStartColor()

Gets header start color.

Overrides:

getHeaderStartColor in class StiDataBand

getHeaderEndColor

public StiColor getHeaderEndColor()

Gets header end color.

Overrides:

getHeaderEndColor in class StiDataBand

getKeyDataColumn

public final String getKeyDataColumn()

Gets or sets column which contains data key.

setKeyDataColumn

public final void setKeyDataColumn(String value)

getMasterKeyDataColumn

public final String getMasterKeyDataColumn()

Gets or sets column which contains data master key.

setMasterKeyDataColumn

public final void setMasterKeyDataColumn(String value)

getParentValue

public final String getParentValue()

Gets or sets column which contains parent value which identifies parent rows.

setParentValue

public final void setParentValue(String value)

getIndent

public double getIndent()

Gets or sets indent from the left side of band for offset of data levels.

setIndent

public void setIndent(double value)

getHeaders

public final String getHeaders()

Gets or sets the list of headers for the hierarchical band.

setHeaders

public final void setHeaders(String value)

getFooters

public final String getFooters()

Gets or sets the list of footers for the hierarchical band.

setFooters

public final void setFooters(String value)

getHierarchicalBandInfoV2

public final StiHierarchicalBandInfoV2 getHierarchicalBandInfoV2()

getBusinessObject

public StiBusinessObject getBusinessObject()

Get business object that is used for getting data.

Specified by:

getBusinessObject in interface IStiBusinessObject

Overrides:

getBusinessObject in class StiDataBand

getBuilder

protected StiV2Builder getBuilder()

Overrides:

getBuilder in class StiComponent

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiDataBand

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiDataBand

Throws:

JSONException