Package com.stimulsoft.report.components.bands

Class StiEmptyBand

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

All Implemented Interfaces:

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

public class StiEmptyBand
extends StiBand
implements IStiOddEvenStyles

Desribes the class that realizes the band - Empty Band.

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

Method Summary

Modifier and Type	Method	Description
final StiBeginRenderEvent	getBeginRenderEvent()	Occurs when band begin render.
final StiEndRenderEvent	getEndRenderEvent()	Occurs when band rendering is finished.
String	getEvenStyle()	Gets or sets value, indicates style of even lines.
StiColor	getHeaderEndColor()	Gets header end color.
StiColor	getHeaderStartColor()	Gets header start color.
String	GetHeaderText()	Returns the band header text.
String	getLocalizedName()	Gets a localized component name.
String	getOddStyle()	Gets or sets value, indicates style of odd lines.
int	getPriority()	Gets a component priority.
final StiRenderingEvent	getRenderingEvent()	Occurs when a data row rendering.
StiEmptySizeMode	getSizeMode()	This property allows to indicate how to change the size of the last row on a page.
int	getToolboxPosition()	Gets value to sort a position in the toolbox.
void	InvokeBeginRender()
void	InvokeEndRender()
void	InvokeRendering()
void	LoadFromJsonObject(JSONObject jObject)
protected void	OnBeginRender(EventArgs e)	Raises the BeginRender event for this component.
protected void	OnEndRender(EventArgs e)	Raises the EndRender event for this component.
protected void	OnRendering(EventArgs e)	Raises the Rendering event for this component.
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
final void	setBeginRenderEvent(StiBeginRenderEvent value)
final void	setEndRenderEvent(StiEndRenderEvent value)
void	setEvenStyle(String value)
void	setOddStyle(String value)
final void	setRenderingEvent(StiRenderingEvent value)
void	setSizeMode(StiEmptySizeMode value)

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

canContainIn, clone, getBandInfoV2, getCanGrow, getComponentType, getDefaultClientRectangle, getDisplayRectangle, getDockStyle, getFooterSize, getGrowToHeight, getHeaderSize, 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, Break, BringToFront, ChangePosition, checkBlockedException, CheckBlockedException, checkLargeHeight, ClearAllStates, clone, ContainerToPage, ContainerToPage, convert, Convert, ConvertSelectedToPage, ConvertToPage, Correct, Correct, correct2, getActualSize, getActualSize, getBlocked, getBorder, GetBorder, getBrush, GetBrush, getCanBreak, 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, setCanBreak, 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, 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, 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

StiEmptyBand

public StiEmptyBand()

Creates a new component of the type StiHeaderBand.

StiEmptyBand

public StiEmptyBand(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

GetHeaderText

public 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

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

getEvenStyle

public String getEvenStyle()

Gets or sets value, indicates style of even lines.

Specified by:

getEvenStyle in interface IStiOddEvenStyles

setEvenStyle

public void setEvenStyle(String value)

Specified by:

setEvenStyle in interface IStiOddEvenStyles

getOddStyle

public String getOddStyle()

Gets or sets value, indicates style of odd lines.

Specified by:

getOddStyle in interface IStiOddEvenStyles

setOddStyle

public void setOddStyle(String value)

Specified by:

setOddStyle in interface IStiOddEvenStyles

OnBeginRender

protected void OnBeginRender(EventArgs e)

Raises the BeginRender event for this component.

getBeginRenderEvent

public final StiBeginRenderEvent getBeginRenderEvent()

Occurs when band begin render.

setBeginRenderEvent

public final void setBeginRenderEvent(StiBeginRenderEvent value)

OnRendering

protected void OnRendering(EventArgs e)

Raises the Rendering event for this component.

getRenderingEvent

public final StiRenderingEvent getRenderingEvent()

Occurs when a data row rendering.

setRenderingEvent

public final void setRenderingEvent(StiRenderingEvent value)

OnEndRender

protected void OnEndRender(EventArgs e)

Raises the EndRender event for this component.

getEndRenderEvent

public final StiEndRenderEvent getEndRenderEvent()

Occurs when band rendering is finished.

setEndRenderEvent

public final void setEndRenderEvent(StiEndRenderEvent value)

getSizeMode

public StiEmptySizeMode getSizeMode()

This property allows to indicate how to change the size of the last row on a page.

setSizeMode

public void setSizeMode(StiEmptySizeMode value)

InvokeBeginRender

public void InvokeBeginRender()

Overrides:

InvokeBeginRender in class StiComponent

InvokeRendering

public void InvokeRendering()

InvokeEndRender

public void InvokeEndRender()

Overrides:

InvokeEndRender in class StiComponent

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiBand

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiBand

Throws:

JSONException