Class StiGroupHeaderBand
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.StiGroupHeaderBand
- All Implemented Interfaces:
IStiAppExpressionCollection,IStiJsonReportObject,IStiForceSerializable,IStiSerializable,IStiSerializableRef,IStiSerializableToAttributes,IStiName,IStiBorder,IStiBreakable,IStiBrush,IStiCanGrow,IStiCanShrink,IStiComponentGuid,IStiConditions,IStiGroup,IStiGrowToHeight,IStiInteraction,IStiKeepGroupTogether,IStiPageBreak,IStiPrintAtBottom,IStiPrintOn,IStiPrintOnAllPages,IStiResetPageNumber,IStiSelect,IStiShift,IStiStartNewPage,IStiUnitConvert,IStiReportProperty,IStiIgnoryStyle,IStiInherited,IStiStateSaveRestore,Cloneable
- Direct Known Subclasses:
StiCrossGroupHeaderBand
public class StiGroupHeaderBand
extends StiDynamicBand
implements IStiGroup, IStiPrintOnAllPages, IStiKeepGroupTogether, IStiStartNewPage
-
Field Summary
FieldsFields inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer
border, brush, collapsingIndex, components, engine, ParentComponentIsBand, ParentComponentIsCrossBand, PropertyBlockedFields 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, widthFields inherited from class com.stimulsoft.base.services.StiService
propertiesFields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef
REFERENCE_EMPTY, REFERENCE_REPORT -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new component of the type StiComponent.Creates a new component of the type StiComponent with specified location. -
Method Summary
Modifier and TypeMethodDescriptionfinal StiBeginRenderEventOccurs when band is begin render.booleanGets or sets value which indicates whether the component can or cannot break its contents on several pages.Gets or sets an expression to fill a collapsed value.Gets the type of processing when printing.Gets or sets grouping condition.final ObjectReturns the DataBand in which the component is located.final StiEndRenderEventOccurs when ends rendering band.Return events collection of this component.final StiGetCollapsedEventOccurs when the Collapsed value is calculated.Occurs when when group summary expression is calculated.Occurs when when is checked condition of the group.final StiGroupHeaderBandInfoV1final StiGroupHeaderBandInfoV2Gets header end color.Gets header start color.Returns the band header text.booleanGets or sets value indicates that group header is printed with data together.booleanGets or sets value indicates that group is to be kept together.final intgetLine()Gets a localized component name.booleanGets or sets value indicates that the component is printed on all pages.intGets a component priority.final StiRenderingEventOccurs when occurs rendering of one line data.booleanAllows to reset page number on this component.final StiGroupSortDirectionGets or sets sorting direction of group by totals.booleanGets or sets value indicates that it is necessary to print every new string on a new page.floatGets or sets value which indicates how much free space on a page (in percentage terms) should be reserved for formation of a new page.Gets or sets summary expression which is used for group summary totals calculation.final StiGroupSortDirectionGets or sets function of calculating group totals for its sorting by totals.final StiGroupSummaryTypeGets or sets the sorting direction of grouped data.intGets value to sort a position in the toolbox.voidvoidvoidfinal voidfinal voidvoidvoidLoadFromJsonObject(JSONObject jObject) protected voidRaises the BeginRender event for this component.protected voidRaises the EndRender event for this component.protected voidRaises the GetCollapsed event for this component.protected voidRaises the GetSummaryExpression event for this component.protected voidRaises the GetValue event for this component.protected voidRaises the Rendering event for this component.voidRestoreState(String stateName) Restores the earlier saved object state.voidSaves the current state of an object.final voidvoidsetCanBreak(boolean value) Gets or sets value which indicates whether the component can or cannot break its contents on several pages.voidfinal voidfinal voidfinal voidfinal voidfinal voidvoidsetKeepGroupHeaderTogether(boolean value) voidsetKeepGroupTogether(boolean value) final voidsetLine(int value) voidsetPrintOnAllPages(boolean value) final voidvoidsetResetPageNumber(boolean value) final voidvoidsetStartNewPage(boolean value) voidsetStartNewPageIfLessThan(float value) final voidfinal voidfinal voidMethods inherited from class com.stimulsoft.report.components.bands.StiDynamicBand
Break, getBreakIfLessThan, getNewColumnAfter, getNewColumnBefore, getNewPageAfter, getNewPageBefore, getPrintAtBottom, getSkipFirst, setBreakIfLessThan, setNewColumnAfter, setNewColumnBefore, setNewPageAfter, setNewPageBefore, setPrintAtBottom, setSkipFirstMethods inherited from class com.stimulsoft.report.components.bands.StiBand
canContainIn, clone, 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, setWidthMethods 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, 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, SortByPriorityMethods 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, 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, 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, UnPrepareMethods inherited from class com.stimulsoft.report.StiBase
getServiceNameMethods inherited from class com.stimulsoft.base.services.StiService
getProperties, getServiceEnabled, getServiceInfo, isPropertyPresent, MemberwiseClone, properties, setProperties, setServiceEnabledMethods inherited from class com.stimulsoft.base.serializing.StiSerializedObject
cleanReference, getReference, setReferenceMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef
getReference, setReference
-
Field Details
-
line
public int line
-
-
Constructor Details
-
StiGroupHeaderBand
public StiGroupHeaderBand()Creates a new component of the type StiComponent. -
StiGroupHeaderBand
Creates a new component of the type StiComponent with specified location.- Parameters:
rect- The rectangle describes size and position of the component.
-
-
Method Details
-
getCanBreak
public boolean getCanBreak()Gets or sets value which indicates whether the component can or cannot break its contents on several pages.- Specified by:
getCanBreakin interfaceIStiBreakable- Overrides:
getCanBreakin classStiContainer
-
setCanBreak
public void setCanBreak(boolean value) Description copied from class:StiDynamicBandGets or sets value which indicates whether the component can or cannot break its contents on several pages.- Specified by:
setCanBreakin interfaceIStiBreakable- Overrides:
setCanBreakin classStiDynamicBand
-
getResetPageNumber
public boolean getResetPageNumber()Allows to reset page number on this component.- Specified by:
getResetPageNumberin interfaceIStiResetPageNumber- Overrides:
getResetPageNumberin classStiBand
-
setResetPageNumber
public void setResetPageNumber(boolean value) - Specified by:
setResetPageNumberin interfaceIStiResetPageNumber- Overrides:
setResetPageNumberin classStiBand
-
getKeepGroupHeaderTogether
public boolean getKeepGroupHeaderTogether()Gets or sets value indicates that group header is printed with data together. -
setKeepGroupHeaderTogether
public void setKeepGroupHeaderTogether(boolean value) -
getKeepGroupTogether
public boolean getKeepGroupTogether()Gets or sets value indicates that group is to be kept together.- Specified by:
getKeepGroupTogetherin interfaceIStiKeepGroupTogether
-
setKeepGroupTogether
public void setKeepGroupTogether(boolean value) - Specified by:
setKeepGroupTogetherin interfaceIStiKeepGroupTogether
-
getStartNewPage
public boolean getStartNewPage()Gets or sets value indicates that it is necessary to print every new string on a new page.- Specified by:
getStartNewPagein interfaceIStiStartNewPage
-
setStartNewPage
public void setStartNewPage(boolean value) - Specified by:
setStartNewPagein interfaceIStiStartNewPage
-
getStartNewPageIfLessThan
public float getStartNewPageIfLessThan()Gets or sets value which indicates how much free space on a page (in percentage terms) should be reserved for formation of a new page. The value should be set in the range from 0 to 100. If the value is 100 then, in any case, a new page will be formed. This property is used together with the StartNewPage property.- Specified by:
getStartNewPageIfLessThanin interfaceIStiStartNewPage
-
setStartNewPageIfLessThan
public void setStartNewPageIfLessThan(float value) - Specified by:
setStartNewPageIfLessThanin interfaceIStiStartNewPage
-
saveState
Saves the current state of an object.- Specified by:
saveStatein interfaceIStiStateSaveRestore- Overrides:
saveStatein classStiContainer- Parameters:
stateName- A name of the state being saved.
-
RestoreState
Restores the earlier saved object state.- Overrides:
RestoreStatein classStiContainer- Parameters:
stateName- A name of the state being restored.
-
getSortDirection
Gets or sets sorting direction of group by totals.- Specified by:
getSortDirectionin interfaceIStiGroup
-
setSortDirection
- Specified by:
setSortDirectionin interfaceIStiGroup
-
getSummarySortDirection
Gets or sets function of calculating group totals for its sorting by totals. -
setSummarySortDirection
-
getSummaryType
Gets or sets the sorting direction of grouped data. -
setSummaryType
-
getPrintOnAllPages
public boolean getPrintOnAllPages()Gets or sets value indicates that the component is printed on all pages.- Specified by:
getPrintOnAllPagesin interfaceIStiPrintOnAllPages
-
setPrintOnAllPages
public void setPrintOnAllPages(boolean value) - Specified by:
setPrintOnAllPagesin interfaceIStiPrintOnAllPages
-
getGroupHeaderBandInfoV1
-
getGroupHeaderBandInfoV2
-
getDataBand
Returns the DataBand in which the component is located. Returns null, if nothing is located.- Overrides:
getDataBandin classStiComponent- Returns:
- A DataBand in which the component is located.
-
getLine
public final int getLine() -
setLine
public final void setLine(int value) -
getEvents
Return events collection of this component.- Overrides:
getEventsin classStiComponent
-
getToolboxPosition
public int getToolboxPosition()Gets value to sort a position in the toolbox.- Overrides:
getToolboxPositionin classStiContainer
-
getComponentType
Gets the type of processing when printing.- Overrides:
getComponentTypein classStiBand
-
getLocalizedName
Gets a localized component name.- Overrides:
getLocalizedNamein classStiContainer
-
getPriority
public int getPriority()Gets a component priority.- Overrides:
getPriorityin classStiContainer
-
getCondition
Gets or sets grouping condition.- Specified by:
getConditionin interfaceIStiGroup
-
setCondition
- Specified by:
setConditionin interfaceIStiGroup
-
getSummaryExpression
Gets or sets summary expression which is used for group summary totals calculation. -
setSummaryExpression
-
getCollapsed
Gets or sets an expression to fill a collapsed value. -
setCollapsed
-
OnGetSummaryExpression
Raises the GetSummaryExpression event for this component. -
getGetSummaryExpressionEvent
Occurs when when group summary expression is calculated. -
setGetSummaryExpressionEvent
-
OnGetValue
Raises the GetValue event for this component. -
getGetValueEvent
Occurs when when is checked condition of the group. -
setGetValueEvent
-
OnGetCollapsed
Raises the GetCollapsed event for this component. -
getGetCollapsedEvent
Occurs when the Collapsed value is calculated. -
setGetCollapsedEvent
-
OnBeginRender
Raises the BeginRender event for this component. -
getBeginRenderEvent
Occurs when band is begin render. -
setBeginRenderEvent
-
OnRendering
Raises the Rendering event for this component. -
getRenderingEvent
Occurs when occurs rendering of one line data. -
setRenderingEvent
-
OnEndRender
Raises the EndRender event for this component. -
getEndRenderEvent
Occurs when ends rendering band. -
setEndRenderEvent
-
GetHeaderText
Returns the band header text.- Overrides:
GetHeaderTextin classStiBand- Returns:
- Band header text.
-
getHeaderStartColor
Gets header start color.- Specified by:
getHeaderStartColorin classStiBand
-
getHeaderEndColor
Gets header end color.- Specified by:
getHeaderEndColorin classStiBand
-
InvokeGetCollapsed
-
InvokeRendering
public void InvokeRendering() -
InvokeBeginRender
public void InvokeBeginRender()- Overrides:
InvokeBeginRenderin classStiComponent
-
InvokeEndRender
public void InvokeEndRender()- Overrides:
InvokeEndRenderin classStiComponent
-
InvokeGetSummaryExpression
-
InvokeGetValue
-
GetCurrentConditionValue
-
SaveToJsonObject
- Specified by:
SaveToJsonObjectin interfaceIStiJsonReportObject- Overrides:
SaveToJsonObjectin classStiDynamicBand- Throws:
JSONException
-
LoadFromJsonObject
- Specified by:
LoadFromJsonObjectin interfaceIStiJsonReportObject- Overrides:
LoadFromJsonObjectin classStiDynamicBand- Throws:
JSONException
-