Package com.stimulsoft.report.components.bands

Class StiHeaderBand

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

All Implemented Interfaces:

IStiAppExpressionCollection, IStiJsonReportObject, IStiForceSerializable, IStiSerializable, IStiSerializableRef, IStiSerializableToAttributes, IStiName, IStiBorder, IStiBreakable, IStiBrush, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiGrowToHeight, IStiInteraction, IStiKeepHeaderTogether, IStiPageBreak, IStiPrintAtBottom, IStiPrintIfEmpty, IStiPrintOn, IStiPrintOnAllPages, IStiPrintOnEvenOddPages, IStiResetPageNumber, IStiSelect, IStiShift, IStiStartNewPage, IStiUnitConvert, IStiReportProperty, IStiIgnoryStyle, IStiInherited, IStiStateSaveRestore, Cloneable

Direct Known Subclasses:

StiColumnHeaderBand, StiCrossHeaderBand

public class StiHeaderBand
extends StiDynamicBand
implements IStiPrintIfEmpty, IStiPrintOnAllPages, IStiPrintOnEvenOddPages, IStiStartNewPage, IStiKeepHeaderTogether

Field Summary

Fields

Modifier and Type	Field	Description
boolean	keepHeaderTogether

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
StiHeaderBand()	Creates a new component of the type StiHeaderBand.
StiHeaderBand(StiRectangle rect)	Creates a new component of the type StiHeaderBand with specified location.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Creates a new object that is a copy of the current instance.
boolean	getCanBreak()	Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
StiComponentType	getComponentType()	Gets the type of processing when printing.
final StiHeaderBandInfoV1	getHeaderBandInfoV1()
final StiHeaderBandInfoV2	getHeaderBandInfoV2()
StiColor	getHeaderEndColor()	Gets header end color.
StiColor	getHeaderStartColor()	Gets header start color.
boolean	getKeepHeaderTogether()	Gets or sets value indicates that header is printed with data together.
String	getLocalizedName()	Gets a localized component name.
boolean	getPrintIfEmpty()	Gets or sets value indicates that the header if data not present.
boolean	getPrintOnAllPages()	Gets or sets value indicates that the component is printed on all pages.
StiPrintOnEvenOddPagesType	getPrintOnEvenOddPages()	Gets or sets value indicates that the component is printed on even-odd pages.
int	getPriority()	Gets a component priority.
boolean	getResetPageNumber()	Allows to reset page number on this band.
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.
int	getToolboxPosition()	Gets value to sort a position in the toolbox.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setCanBreak(boolean value)	Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
void	setKeepHeaderTogether(boolean value)
void	setPrintIfEmpty(boolean value)
void	setPrintOnAllPages(boolean value)
void	setPrintOnEvenOddPages(StiPrintOnEvenOddPagesType value)
void	setResetPageNumber(boolean value)
void	setStartNewPage(boolean value)
void	setStartNewPageIfLessThan(float 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, GetHeaderText, 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, 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, RestoreState, saveState, 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, 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

Field Details

keepHeaderTogether

public boolean keepHeaderTogether

Constructor Details

StiHeaderBand

public StiHeaderBand()

Creates a new component of the type StiHeaderBand.

StiHeaderBand

public StiHeaderBand(StiRectangle rect)

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

Parameters:

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

Method Details

getHeaderEndColor

public StiColor getHeaderEndColor()

Gets header end color.

Specified by:

getHeaderEndColor in class StiBand

getKeepHeaderTogether

public boolean getKeepHeaderTogether()

Gets or sets value indicates that header is printed with data together.

Specified by:

getKeepHeaderTogether in interface IStiKeepHeaderTogether

setKeepHeaderTogether

public void setKeepHeaderTogether(boolean value)

Specified by:

setKeepHeaderTogether in interface IStiKeepHeaderTogether

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

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

getResetPageNumber

public boolean getResetPageNumber()

Allows to reset page number on this band.

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

getPrintIfEmpty

public boolean getPrintIfEmpty()

Gets or sets value indicates that the header if data not present.

Specified by:

getPrintIfEmpty in interface IStiPrintIfEmpty

setPrintIfEmpty

public void setPrintIfEmpty(boolean value)

Specified by:

setPrintIfEmpty in interface IStiPrintIfEmpty

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

getPrintOnEvenOddPages

public StiPrintOnEvenOddPagesType getPrintOnEvenOddPages()

Gets or sets value indicates that the component is printed on even-odd pages.

Specified by:

getPrintOnEvenOddPages in interface IStiPrintOnEvenOddPages

setPrintOnEvenOddPages

public void setPrintOnEvenOddPages(StiPrintOnEvenOddPagesType value)

Specified by:

setPrintOnEvenOddPages in interface IStiPrintOnEvenOddPages

getHeaderBandInfoV1

public final StiHeaderBandInfoV1 getHeaderBandInfoV1()

getHeaderBandInfoV2

public final StiHeaderBandInfoV2 getHeaderBandInfoV2()

getToolboxPosition

public int getToolboxPosition()

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiContainer

getPriority

public int getPriority()

Gets a component priority.

Overrides:

getPriority in class StiContainer

getLocalizedName

public String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiContainer

getComponentType

public StiComponentType getComponentType()

Gets the type of processing when printing.

Overrides:

getComponentType in class StiBand

getHeaderStartColor

public StiColor getHeaderStartColor()

Gets header start color.

Specified by:

getHeaderStartColor in class StiBand

clone

public Object clone()

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

Overrides:

clone in class StiComponent

Returns:

A new object that is a copy of this instance.

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