Class StiCrossGroupHeaderBand
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
com.stimulsoft.report.components.crossBands.StiCrossGroupHeaderBand
- 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
The class describes Cross Group Header Band.
-
Field Summary
Fields inherited from class com.stimulsoft.report.components.bands.StiGroupHeaderBand
lineFields 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 StiCrossGroupHeaderBand.Creates a new component of the type StiCrossGroupHeaderBand with specified location. -
Method Summary
Modifier and TypeMethodDescriptionfloatGets 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.booleanGets or sets value which indicates whether the component can or cannot break its contents on several pages.Gets or sets the default client area of a component.Gets or sets a rectangle of the component which it fills.Gets or sets a type of the component docking.booleangets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.doubleGets the header height.doublebooleanGets value, indicates that this cross is the component.Gets a localized name of the component category.Gets a localized component name.doubleGets or sets maximal height of band.gets or sets maximal size.doubleGets or sets maximal width of band.doubleGets or sets minimal height of band.gets or sets minimal size.doubleGets or sets minimal width of band.booleanIf the value of this property is true, then, after output of a band, a new column will be generated.booleanIf the value of this property is true, then, before output of a band, a new column will be generated.booleanIf the value of this property is true, then, after output of a band, a new page will be generated.booleanIf the value of this property is true, then, before output of a band, a new page will be generated.booleanGets or sets value indicates that the footer is printed at bottom of page.booleanGets or sets value indicates that the component is printed on all pages.intGets a component priority.booleanAllows to reset page number on this component.Gets or sets a rectangle of the component selection.booleanIf the value of this property is true, then, a new page/column will be generated only starting from the second case.booleanGets or sets value indicates that it is necessary to print every new string on a new page.intGets value to sort a position in the toolbox.doublegetWidth()gets or sets width of a component.voidLoadFromJsonObject(JSONObject jObject) voidsetBreakIfLessThan(float value) voidsetCanBreak(boolean value) Gets or sets value which indicates whether the component can or cannot break its contents on several pages.voidsetDisplayRectangle(StiRectangle value) voidsetDockStyle(StiDockStyle value) voidsetGrowToHeight(boolean value) voidsetHeight(double value) voidsetMaxHeight(double value) voidsetMaxSize(StiSize value) voidsetMaxWidth(double value) voidsetMinHeight(double value) voidsetMinSize(StiSize value) voidsetMinWidth(double value) voidsetNewColumnAfter(boolean value) voidsetNewColumnBefore(boolean value) voidsetNewPageAfter(boolean value) voidsetNewPageBefore(boolean value) voidsetPrintAtBottom(boolean value) voidsetPrintOnAllPages(boolean value) voidsetResetPageNumber(boolean value) voidsetSelectRectangle(StiRectangle value) Returns the GroupHeaderBand in which the component is loc * null, if nothing is located.voidsetSkipFirst(boolean value) voidsetStartNewPage(boolean value) voidsetWidth(double value) Methods inherited from class com.stimulsoft.report.components.bands.StiGroupHeaderBand
getBeginRenderEvent, getCollapsed, getComponentType, getCondition, GetCurrentConditionValue, getDataBand, getEndRenderEvent, getEvents, getGetCollapsedEvent, getGetSummaryExpressionEvent, getGetValueEvent, getGroupHeaderBandInfoV1, getGroupHeaderBandInfoV2, getHeaderEndColor, getHeaderStartColor, GetHeaderText, getKeepGroupHeaderTogether, getKeepGroupTogether, getLine, getRenderingEvent, getSortDirection, getStartNewPageIfLessThan, getSummaryExpression, getSummarySortDirection, getSummaryType, InvokeBeginRender, InvokeEndRender, InvokeGetCollapsed, InvokeGetSummaryExpression, InvokeGetValue, InvokeRendering, OnBeginRender, OnEndRender, OnGetCollapsed, OnGetSummaryExpression, OnGetValue, OnRendering, RestoreState, saveState, setBeginRenderEvent, setCollapsed, setCondition, setEndRenderEvent, setGetCollapsedEvent, setGetSummaryExpressionEvent, setGetValueEvent, setKeepGroupHeaderTogether, setKeepGroupTogether, setLine, setRenderingEvent, setSortDirection, setStartNewPageIfLessThan, setSummaryExpression, setSummarySortDirection, setSummaryTypeMethods inherited from class com.stimulsoft.report.components.bands.StiDynamicBand
BreakMethods inherited from class com.stimulsoft.report.components.bands.StiBand
canContainIn, clone, getBandInfoV2, getCanGrow, getFooterSize, getLeft, getNestedLevel, getPrintable, getQuickInfo, getRectangleMoveComponent, getShiftMode, getTop, isAutomaticDock, setCanGrow, setDirectDisplayRectangle, setLeft, setPrintable, setRectangleMoveComponent, setShiftMode, setTopMethods 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, 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, 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, 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
-
Constructor Details
-
StiCrossGroupHeaderBand
public StiCrossGroupHeaderBand()Creates a new component of the type StiCrossGroupHeaderBand. -
StiCrossGroupHeaderBand
Creates a new component of the type StiCrossGroupHeaderBand with specified location.- Parameters:
rect- The rectangle describes size and position of the component.
-
-
Method Details
-
getNewPageBefore
public boolean getNewPageBefore()Description copied from class:StiDynamicBandIf 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:
getNewPageBeforein interfaceIStiPageBreak- Overrides:
getNewPageBeforein classStiDynamicBand
-
setNewPageBefore
public void setNewPageBefore(boolean value) - Specified by:
setNewPageBeforein interfaceIStiPageBreak- Overrides:
setNewPageBeforein classStiDynamicBand
-
getNewPageAfter
public boolean getNewPageAfter()Description copied from class:StiDynamicBandIf the value of this property is true, then, after output of a band, a new page will be generated.- Specified by:
getNewPageAfterin interfaceIStiPageBreak- Overrides:
getNewPageAfterin classStiDynamicBand
-
setNewPageAfter
public void setNewPageAfter(boolean value) - Specified by:
setNewPageAfterin interfaceIStiPageBreak- Overrides:
setNewPageAfterin classStiDynamicBand
-
getNewColumnBefore
public boolean getNewColumnBefore()Description copied from class:StiDynamicBandIf 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:
getNewColumnBeforein interfaceIStiPageBreak- Overrides:
getNewColumnBeforein classStiDynamicBand
-
setNewColumnBefore
public void setNewColumnBefore(boolean value) - Specified by:
setNewColumnBeforein interfaceIStiPageBreak- Overrides:
setNewColumnBeforein classStiDynamicBand
-
getNewColumnAfter
public boolean getNewColumnAfter()Description copied from class:StiDynamicBandIf the value of this property is true, then, after output of a band, a new column will be generated.- Specified by:
getNewColumnAfterin interfaceIStiPageBreak- Overrides:
getNewColumnAfterin classStiDynamicBand
-
setNewColumnAfter
public void setNewColumnAfter(boolean value) - Specified by:
setNewColumnAfterin interfaceIStiPageBreak- Overrides:
setNewColumnAfterin classStiDynamicBand
-
getSkipFirst
public boolean getSkipFirst()Description copied from class:StiDynamicBandIf the value of this property is true, then, a new page/column will be generated only starting from the second case.- Specified by:
getSkipFirstin interfaceIStiPageBreak- Overrides:
getSkipFirstin classStiDynamicBand
-
setSkipFirst
public void setSkipFirst(boolean value) - Specified by:
setSkipFirstin interfaceIStiPageBreak- Overrides:
setSkipFirstin classStiDynamicBand
-
getBreakIfLessThan
public float getBreakIfLessThan()Description copied from class:StiDynamicBandGets 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:
getBreakIfLessThanin interfaceIStiPageBreak- Overrides:
getBreakIfLessThanin classStiDynamicBand
-
setBreakIfLessThan
public void setBreakIfLessThan(float value) - Specified by:
setBreakIfLessThanin interfaceIStiPageBreak- Overrides:
setBreakIfLessThanin classStiDynamicBand
-
getGrowToHeight
public boolean getGrowToHeight()Description copied from class:StiComponentgets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.- Specified by:
getGrowToHeightin interfaceIStiGrowToHeight- Overrides:
getGrowToHeightin classStiBand
-
setGrowToHeight
public void setGrowToHeight(boolean value) - Specified by:
setGrowToHeightin interfaceIStiGrowToHeight- Overrides:
setGrowToHeightin classStiBand
-
getResetPageNumber
public boolean getResetPageNumber()Description copied from class:StiGroupHeaderBandAllows to reset page number on this component.- Specified by:
getResetPageNumberin interfaceIStiResetPageNumber- Overrides:
getResetPageNumberin classStiGroupHeaderBand
-
setResetPageNumber
public void setResetPageNumber(boolean value) - Specified by:
setResetPageNumberin interfaceIStiResetPageNumber- Overrides:
setResetPageNumberin classStiGroupHeaderBand
-
getStartNewPage
public boolean getStartNewPage()Description copied from class:StiGroupHeaderBandGets or sets value indicates that it is necessary to print every new string on a new page.- Specified by:
getStartNewPagein interfaceIStiStartNewPage- Overrides:
getStartNewPagein classStiGroupHeaderBand
-
setStartNewPage
public void setStartNewPage(boolean value) - Specified by:
setStartNewPagein interfaceIStiStartNewPage- Overrides:
setStartNewPagein classStiGroupHeaderBand
-
getPrintOnAllPages
public boolean getPrintOnAllPages()Description copied from class:StiGroupHeaderBandGets or sets value indicates that the component is printed on all pages.- Specified by:
getPrintOnAllPagesin interfaceIStiPrintOnAllPages- Overrides:
getPrintOnAllPagesin classStiGroupHeaderBand
-
setPrintOnAllPages
public void setPrintOnAllPages(boolean value) - Specified by:
setPrintOnAllPagesin interfaceIStiPrintOnAllPages- Overrides:
setPrintOnAllPagesin classStiGroupHeaderBand
-
getPrintAtBottom
public boolean getPrintAtBottom()Description copied from class:StiDynamicBandGets or sets value indicates that the footer is printed at bottom of page.- Specified by:
getPrintAtBottomin interfaceIStiPrintAtBottom- Overrides:
getPrintAtBottomin classStiDynamicBand
-
setPrintAtBottom
public void setPrintAtBottom(boolean value) - Specified by:
setPrintAtBottomin interfaceIStiPrintAtBottom- Overrides:
setPrintAtBottomin classStiDynamicBand
-
getCanBreak
public boolean getCanBreak()Description copied from class:StiGroupHeaderBandGets or sets value which indicates whether the component can or cannot break its contents on several pages.- Specified by:
getCanBreakin interfaceIStiBreakable- Overrides:
getCanBreakin classStiGroupHeaderBand
-
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 classStiGroupHeaderBand
-
getToolboxPosition
public int getToolboxPosition()Gets value to sort a position in the toolbox.- Overrides:
getToolboxPositionin classStiGroupHeaderBand
-
getLocalizedCategory
Gets a localized name of the component category.- Overrides:
getLocalizedCategoryin classStiBand
-
getLocalizedName
Gets a localized component name.- Overrides:
getLocalizedNamein classStiGroupHeaderBand
-
getIsCross
public boolean getIsCross()Gets value, indicates that this cross is the component.- Overrides:
getIsCrossin classStiComponent
-
getPriority
public int getPriority()Gets a component priority.- Overrides:
getPriorityin classStiGroupHeaderBand
-
getDockStyle
Gets or sets a type of the component docking.- Overrides:
getDockStylein classStiBand
-
setDockStyle
- Overrides:
setDockStylein classStiBand
-
getMinSize
Description copied from class:StiComponentgets or sets minimal size.- Overrides:
getMinSizein classStiBand
-
setMinSize
- Overrides:
setMinSizein classStiBand
-
getMaxSize
Description copied from class:StiComponentgets or sets maximal size.- Overrides:
getMaxSizein classStiBand
-
setMaxSize
- Overrides:
setMaxSizein classStiBand
-
getMaxHeight
public double getMaxHeight()Description copied from class:StiBandGets or sets maximal height of band.- Overrides:
getMaxHeightin classStiBand
-
setMaxHeight
public void setMaxHeight(double value) - Overrides:
setMaxHeightin classStiBand
-
getMinHeight
public double getMinHeight()Description copied from class:StiBandGets or sets minimal height of band.- Overrides:
getMinHeightin classStiBand
-
setMinHeight
public void setMinHeight(double value) - Overrides:
setMinHeightin classStiBand
-
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:StiComponentgets or sets width of a component. -
setWidth
public void setWidth(double value) -
getHeight
public double getHeight()- Overrides:
getHeightin classStiComponent
-
setHeight
public void setHeight(double value) - Overrides:
setHeightin classStiComponent
-
getDefaultClientRectangle
Gets or sets the default client area of a component.- Overrides:
getDefaultClientRectanglein classStiBand
-
getSelectRectangle
Gets or sets a rectangle of the component selection.- Overrides:
getSelectRectanglein classStiBand
-
setSelectRectangle
Description copied from class:StiComponentReturns the GroupHeaderBand in which the component is loc * null, if nothing is located.- Overrides:
setSelectRectanglein classStiBand
-
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:
getDisplayRectanglein classStiBand
-
setDisplayRectangle
- Overrides:
setDisplayRectanglein classStiBand
-
getHeaderSize
public double getHeaderSize()Gets the header height.- Overrides:
getHeaderSizein classStiBand
-
SaveToJsonObject
- Specified by:
SaveToJsonObjectin interfaceIStiJsonReportObject- Overrides:
SaveToJsonObjectin classStiGroupHeaderBand- Throws:
JSONException
-
LoadFromJsonObject
- Specified by:
LoadFromJsonObjectin interfaceIStiJsonReportObject- Overrides:
LoadFromJsonObjectin classStiGroupHeaderBand- Throws:
JSONException
-