Package com.stimulsoft.report.components.bands

Class StiPageHeaderBand

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

com.stimulsoft.report.components.bands.StiPageHeaderBand

All Implemented Interfaces:

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

public class StiPageHeaderBand
extends StiStaticBand
implements IStiBreakable, IStiPrintOnEvenOddPages

Field Summary

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

Method Summary

Modifier and Type	Method	Description
boolean	Break(StiComponent dividedComponent, double devideFactor, StiRefObject<Double> divLine, StiRefObject<Boolean> haveBreaked)	Divides content of components in two parts.
boolean	canContainIn(StiComponent component)	May this container be located in the specified component.
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.
StiColor	getHeaderEndColor()	Gets header end color.
StiColor	getHeaderStartColor()	Gets header start color.
String	getLocalizedName()	Gets a localized component name.
final StiComponent	GetMaster()	Returns Master component of this component.
StiPrintOnEvenOddPagesType	getPrintOnEvenOddPages()	Gets or sets value indicates that the component is printed on even-odd pages.
final boolean	getPrintOnFirstPage()
int	getPriority()	Gets a component priority.
int	getToolboxPosition()	Gets value to sort a position in the toolbox.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setCanBreak(boolean value)
void	setPrintOnEvenOddPages(StiPrintOnEvenOddPagesType value)
final void	setPrintOnFirstPage(boolean value)

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

clone, getBandInfoV2, getCanGrow, getDefaultClientRectangle, getDisplayRectangle, getDockStyle, getFooterSize, getGrowToHeight, getHeaderSize, GetHeaderText, getLeft, getLocalizedCategory, getMaxHeight, getMaxSize, getMinHeight, getMinSize, getNestedLevel, getPrintable, getQuickInfo, getRectangleMoveComponent, getResetPageNumber, getSelectRectangle, getShiftMode, getTop, getWidth, isAutomaticDock, setCanGrow, setDirectDisplayRectangle, setDisplayRectangle, setDockStyle, setGrowToHeight, setLeft, setMaxHeight, setMaxSize, setMinHeight, setMinSize, setPrintable, setRectangleMoveComponent, setResetPageNumber, 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, 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, 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

Constructor Details

StiPageHeaderBand

public StiPageHeaderBand()

Creates a new component of the type StiPageHeaderBand.

StiPageHeaderBand

public StiPageHeaderBand(StiRectangle rect)

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

Parameters:

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

Method Details

getCanBreak

public boolean getCanBreak()

Description copied from class: StiContainer

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 StiStaticBand

setCanBreak

public void setCanBreak(boolean value)

Specified by:

setCanBreak in interface IStiBreakable

Overrides:

setCanBreak in class StiStaticBand

getHeaderStartColor

public StiColor getHeaderStartColor()

Gets header start color.

Overrides:

getHeaderStartColor in class StiStaticBand

getHeaderEndColor

public StiColor getHeaderEndColor()

Gets header end color.

Overrides:

getHeaderEndColor in class StiStaticBand

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

canContainIn

public boolean canContainIn(StiComponent component)

May this container be located in the specified component.

Overrides:

canContainIn in class StiBand

Parameters:

component - Component for checking.

Returns:

true, if this container may is located in the specified component.

getComponentType

public StiComponentType getComponentType()

Gets the type of processing when printing.

Overrides:

getComponentType in class StiStaticBand

getLocalizedName

public String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiContainer

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

getPrintOnFirstPage

public final boolean getPrintOnFirstPage()

setPrintOnFirstPage

public final void setPrintOnFirstPage(boolean value)

Break

public boolean Break(StiComponent dividedComponent,
 double devideFactor,
 StiRefObject<Double> divLine,
 StiRefObject<Boolean> haveBreaked)

Description copied from class: StiStaticBand

Divides content of components in two parts. Returns result of dividing. If true, then component is successful divided.

Specified by:

Break in interface IStiBreakable

Overrides:

Break in class StiStaticBand

Parameters:

dividedComponent - Component for store part of content.

Returns:

If true, then component is successful divided.

GetMaster

public final StiComponent GetMaster()

Returns Master component of this component.

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiStaticBand

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiStaticBand

Throws:

JSONException