com.stimulsoft.report.components.bands
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, java.lang.Cloneable

Direct Known Subclasses:

StiCrossGroupHeaderBand

public class StiGroupHeaderBand
extends StiDynamicBand
implements IStiGroup, IStiPrintOnAllPages, IStiKeepGroupTogether, IStiStartNewPage

Field Summary

int

line

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

border, brush, collapsingIndex, components, ParentComponentIsBand, ParentComponentIsCrossBand

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

canGrow, canShrink, componentPlacement, conditions, currentPointer, expressions, interaction, isRendered, page, parent, parentBookmark, parentPointer, top, width

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

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

StiGroupHeaderBand()
Creates a new component of the type StiComponent.

StiGroupHeaderBand(StiRectangle rect)
Creates a new component of the type StiComponent with specified location.

Method Summary

StiBeginRenderEvent	getBeginRenderEvent() Occurs when band is begin render.
boolean	getCanBreak() Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
StiCollapsedExpression	getCollapsed() Gets or sets an expression to fill a collapsed value.
StiComponentType	getComponentType() Gets the type of processing when printing.
StiGroupConditionExpression	getCondition() Gets or sets grouping condition.
java.lang.Object	GetCurrentConditionValue()
StiDataBand	getDataBand() Returns the DataBand in which the component is located.
StiEndRenderEvent	getEndRenderEvent() Occurs when ends rendering band.
StiEventsCollection	getEvents() Return events collection of this component.
StiGetCollapsedEvent	getGetCollapsedEvent() Occurs when the Collapsed value is calculated.
StiGetSummaryExpressionEvent	getGetSummaryExpressionEvent() Occurs when when group summary expression is calculated.
StiGetGroupConditionEvent	getGetValueEvent() Occurs when when is checked condition of the group.
StiGroupHeaderBandInfoV1	getGroupHeaderBandInfoV1()
StiGroupHeaderBandInfoV2	getGroupHeaderBandInfoV2()
StiColor	getHeaderEndColor() Gets header end color.
StiColor	getHeaderStartColor() Gets header start color.
java.lang.String	GetHeaderText() Returns the band header text.
boolean	getKeepGroupHeaderTogether() Gets or sets value indicates that group header is printed with data together.
boolean	getKeepGroupTogether() Gets or sets value indicates that group is to be kept together.
int	getLine()
java.lang.String	getLocalizedName() Gets a localized component name.
boolean	getPrintOnAllPages() Gets or sets value indicates that the component is printed on all pages.
int	getPriority() Gets a component priority.
StiRenderingEvent	getRenderingEvent() Occurs when occurs rendering of one line data.
boolean	getResetPageNumber() Allows to reset page number on this component.
StiGroupSortDirection	getSortDirection() Gets or sets sorting direction of group by totals.
boolean	getStartNewPage() Gets or sets value indicates that it is necessary to print every new string on a new page.
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.
StiGroupSummaryExpression	getSummaryExpression() Gets or sets summary expression which is used for group summary totals calculation.
StiGroupSortDirection	getSummarySortDirection() Gets or sets function of calculating group totals for its sorting by totals.
StiGroupSummaryType	getSummaryType() Gets or sets the sorting direction of grouped data.
int	getToolboxPosition() Gets value to sort a position in the toolbox.
void	InvokeGetCollapsed(StiValueEventArgs e)
void	InvokeGetSummaryExpression(StiValueEventArgs e)
void	InvokeGetValue(StiValueEventArgs e)
void	LoadFromJsonObject(JSONObject jObject)
void	RestoreState(java.lang.String stateName) Restores the earlier saved object state.
void	saveState(java.lang.String stateName) Saves the current state of an object.
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setBeginRenderEvent(StiBeginRenderEvent value)
void	setCanBreak(boolean value) Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
void	setCollapsed(StiCollapsedExpression value)
void	setCondition(StiGroupConditionExpression value)
void	setEndRenderEvent(StiEndRenderEvent value)
void	setGetCollapsedEvent(StiGetCollapsedEvent value)
void	setGetSummaryExpressionEvent(StiGetSummaryExpressionEvent value)
void	setGetValueEvent(StiGetGroupConditionEvent value)
void	setKeepGroupHeaderTogether(boolean value)
void	setKeepGroupTogether(boolean value)
void	setLine(int value)
void	setPrintOnAllPages(boolean value)
void	setRenderingEvent(StiRenderingEvent value)
void	setResetPageNumber(boolean value)
void	setSortDirection(StiGroupSortDirection value)
void	setStartNewPage(boolean value)
void	setStartNewPageIfLessThan(float value)
void	setSummaryExpression(StiGroupSummaryExpression value)
void	setSummarySortDirection(StiGroupSortDirection value)
void	setSummaryType(StiGroupSummaryType value)

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

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

Methods 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, setWidth

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

AlignTo, AlignToGrid, AlignToGrid, BringToFront, ChangePosition, checkLargeHeight, ClearAllStates, clone, ContainerToPage, ContainerToPage, convert, Convert, ConvertSelectedToPage, ConvertToPage, Correct, Correct, correct2, getActualSize, getActualSize, 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, 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, applyConditions, CheckForParentComponent, clearAllStates, ClearContents, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, fillComponentPlacement, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getCanShrink, getClickEvent, getComponentPlacement, 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, getTag, getTagStrValue, 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, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getReference, setReference

Field Detail

line

public int line

Constructor Detail

StiGroupHeaderBand

public StiGroupHeaderBand()

Creates a new component of the type StiComponent.

StiGroupHeaderBand

public StiGroupHeaderBand(StiRectangle rect)

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

Parameters:

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

Method Detail

getCanBreak

public boolean getCanBreak()

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

getResetPageNumber

public boolean getResetPageNumber()

Allows to reset page number on this component.

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

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:

getKeepGroupTogether in interface IStiKeepGroupTogether

setKeepGroupTogether

public void setKeepGroupTogether(boolean value)

Specified by:

setKeepGroupTogether in interface IStiKeepGroupTogether

getStartNewPage

public boolean getStartNewPage()

Gets or sets value indicates that it is necessary to print every new string on a new page.

Specified by:

getStartNewPage in interface IStiStartNewPage

setStartNewPage

public void setStartNewPage(boolean value)

Specified by:

setStartNewPage in interface IStiStartNewPage

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:

getStartNewPageIfLessThan in interface IStiStartNewPage

setStartNewPageIfLessThan

public void setStartNewPageIfLessThan(float value)

Specified by:

setStartNewPageIfLessThan in interface IStiStartNewPage

saveState

public void saveState(java.lang.String stateName)

Saves the current state of an object.

Specified by:

saveState in interface IStiStateSaveRestore

Overrides:

saveState in class StiContainer

Parameters:

stateName - A name of the state being saved.

RestoreState

public void RestoreState(java.lang.String stateName)

Restores the earlier saved object state.

Overrides:

RestoreState in class StiContainer

Parameters:

stateName - A name of the state being restored.

getSortDirection

public final StiGroupSortDirection getSortDirection()

Gets or sets sorting direction of group by totals.

Specified by:

getSortDirection in interface IStiGroup

setSortDirection

public final void setSortDirection(StiGroupSortDirection value)

Specified by:

setSortDirection in interface IStiGroup

getSummarySortDirection

public final StiGroupSortDirection getSummarySortDirection()

Gets or sets function of calculating group totals for its sorting by totals.

setSummarySortDirection

public final void setSummarySortDirection(StiGroupSortDirection value)

getSummaryType

public final StiGroupSummaryType getSummaryType()

Gets or sets the sorting direction of grouped data.

setSummaryType

public final void setSummaryType(StiGroupSummaryType value)

getPrintOnAllPages

public boolean getPrintOnAllPages()

Gets or sets value indicates that the component is printed on all pages.

Specified by:

getPrintOnAllPages in interface IStiPrintOnAllPages

setPrintOnAllPages

public void setPrintOnAllPages(boolean value)

Specified by:

setPrintOnAllPages in interface IStiPrintOnAllPages

getGroupHeaderBandInfoV1

public final StiGroupHeaderBandInfoV1 getGroupHeaderBandInfoV1()

getGroupHeaderBandInfoV2

public final StiGroupHeaderBandInfoV2 getGroupHeaderBandInfoV2()

getDataBand

public StiDataBand getDataBand()

Returns the DataBand in which the component is located. Returns null, if nothing is located.

Overrides:

getDataBand in class StiComponent

Returns:

A DataBand in which the component is located.

getLine

public final int getLine()

setLine

public final void setLine(int value)

getEvents

public StiEventsCollection getEvents()

Return events collection of this component.

Overrides:

getEvents in class StiComponent

getToolboxPosition

public int getToolboxPosition()

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiContainer

getComponentType

public StiComponentType getComponentType()

Gets the type of processing when printing.

Overrides:

getComponentType in class StiBand

getLocalizedName

public java.lang.String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiContainer

getPriority

public int getPriority()

Gets a component priority.

Overrides:

getPriority in class StiContainer

getCondition

public final StiGroupConditionExpression getCondition()

Gets or sets grouping condition.

Specified by:

getCondition in interface IStiGroup

setCondition

public final void setCondition(StiGroupConditionExpression value)

Specified by:

setCondition in interface IStiGroup

getSummaryExpression

public final StiGroupSummaryExpression getSummaryExpression()

Gets or sets summary expression which is used for group summary totals calculation.

setSummaryExpression

public final void setSummaryExpression(StiGroupSummaryExpression value)

getCollapsed

public StiCollapsedExpression getCollapsed()

Gets or sets an expression to fill a collapsed value.

setCollapsed

public void setCollapsed(StiCollapsedExpression value)

getGetSummaryExpressionEvent

public final StiGetSummaryExpressionEvent getGetSummaryExpressionEvent()

Occurs when when group summary expression is calculated.

setGetSummaryExpressionEvent

public final void setGetSummaryExpressionEvent(StiGetSummaryExpressionEvent value)

getGetValueEvent

public final StiGetGroupConditionEvent getGetValueEvent()

Occurs when when is checked condition of the group.

setGetValueEvent

public final void setGetValueEvent(StiGetGroupConditionEvent value)

getGetCollapsedEvent

public final StiGetCollapsedEvent getGetCollapsedEvent()

Occurs when the Collapsed value is calculated.

setGetCollapsedEvent

public final void setGetCollapsedEvent(StiGetCollapsedEvent value)

getBeginRenderEvent

public final StiBeginRenderEvent getBeginRenderEvent()

Occurs when band is begin render.

setBeginRenderEvent

public final void setBeginRenderEvent(StiBeginRenderEvent value)

getRenderingEvent

public final StiRenderingEvent getRenderingEvent()

Occurs when occurs rendering of one line data.

setRenderingEvent

public final void setRenderingEvent(StiRenderingEvent value)

getEndRenderEvent

public final StiEndRenderEvent getEndRenderEvent()

Occurs when ends rendering band.

setEndRenderEvent

public final void setEndRenderEvent(StiEndRenderEvent value)

GetHeaderText

public java.lang.String GetHeaderText()

Returns the band header text.

Overrides:

GetHeaderText in class StiBand

Returns:

Band header text.

getHeaderStartColor

public StiColor getHeaderStartColor()

Gets header start color.

Specified by:

getHeaderStartColor in class StiBand

getHeaderEndColor

public StiColor getHeaderEndColor()

Gets header end color.

Specified by:

getHeaderEndColor in class StiBand

InvokeGetCollapsed

public void InvokeGetCollapsed(StiValueEventArgs e)

InvokeGetSummaryExpression

public final void InvokeGetSummaryExpression(StiValueEventArgs e)

InvokeGetValue

public final void InvokeGetValue(StiValueEventArgs e)

GetCurrentConditionValue

public final java.lang.Object GetCurrentConditionValue()

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiDynamicBand

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiDynamicBand

Throws:

JSONException