Package com.stimulsoft.report.components.bands

Class StiTableOfContents

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

com.stimulsoft.report.components.bands.StiTableOfContents

All Implemented Interfaces:

IStiAppExpressionCollection, IStiJsonReportObject, IStiForceSerializable, IStiSerializable, IStiSerializableRef, IStiSerializableToAttributes, IStiName, IStiBorder, IStiBreakable, IStiBrush, IStiBusinessObject, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiDataRelation, IStiDataSource, IStiFilter, IStiGrowToHeight, IStiInteraction, IStiKeepDetailsTogether, IStiKeepFooterTogether, IStiKeepGroupTogether, IStiKeepHeaderTogether, IStiMasterComponent, IStiOddEvenStyles, IStiPageBreak, IStiPrintAtBottom, IStiPrintIfDetailEmpty, IStiPrintOn, IStiPrintOnAllPages, IStiRenderMaster, IStiResetPageNumber, IStiSelect, IStiShift, IStiSort, IStiStartNewPage, IStiUnitConvert, IStiEnumerator, IStiReportProperty, IStiIgnoryStyle, IStiInherited, IStiStateSaveRestore, Cloneable

public class StiTableOfContents
extends StiDataBand

Copyright Stimulsoft

Field Summary

Fields inherited from class com.stimulsoft.report.components.bands.StiDataBand

handlerRendering, isBofValue, isEofValue, jsonMasterComponentTemp, lineThrough, PropertyEvenStyle, PropertyOddStyle

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, 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
StiTableOfContents()
StiTableOfContents(StiRectangle rect)

Method Summary

Modifier and Type	Method	Description
Object	clone(boolean cloneProperties)	Creates a new object that is a copy of the current instanc.
StiComponent	CreateNew()
StiAfterPrintEvent	getAfterPrintEvent()	Occurs after the component printing.
StiBeforePrintEvent	getBeforePrintEvent()	Occurs before printing of the component.
float	getBreakIfLessThan()	Gets 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.
StiBusinessObject	getBusinessObject()	Get business object that is used for getting data.
boolean	getCalcInvisible()	Gets or sets value which indicates that, when aggregate functions calculation, it is nesessary to take into consideration invisible data bands.
boolean	getCanBreak()	Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
boolean	getCanGrow()	Gets or sets value indicates that this object can grow.
boolean	getCanShrink()	gets or sets value which indicates that this object can shrink.
StiClickEvent	getClickEvent()	Occurs when user clicks on the component in the window of viewer.
StiColumnDirection	getColumnDirection()	Gets or sets direction of the rendeting columns.
double	getColumnGaps()	Gets or sets distance between two columns.
int	getColumns()	Gets or sets columns count.
double	getColumnWidth()	Gets or sets width of column.
int	getCountData()	Gets or sets the count of rows for virtual data.
StiDataRelation	getDataRelation()	Get link that is used for master-detail reports rendering.
StiDataSource	getDataSource()	Get data source that is used for getting data.
StiRectangle	getDefaultClientRectangle()	Gets or sets the default client area of a component.
StiDoubleClickEvent	getDoubleClickEvent()	Occurs when user double clicks on the component in the window of viewer.
String	getEvenStyle()	Gets or sets value, indicates style of even lines.
int	getFilterEngine()	Gets or sets how a filter will be applied to data - be means of the report generator or by means of changing the SQL query.
StiFilterMode	getFilterMode()	Gets or sets filter mode.
boolean	getFilterOn()	Gets or sets value indicates, that filter is turn on.
StiFiltersCollection	getFilters()	Gets or sets the collection of data filters.
StiGetBookmarkEvent	getGetBookmarkEvent()	Occurs when getting of the Bookmark for the component.
StiGetDrillDownReportEvent	getGetDrillDownReportEvent()	Occurs when it is required to get a report for the Drill-Down operation.
StiGetHyperlinkEvent	getGetHyperlinkEvent()	Occurs when getting Hyperlink for the component.
StiGetTagEvent	getGetTagEvent()	Occurs when getting a Tag for a component.
StiGetToolTipEvent	getGetToolTipEvent()	Occurs when getting the ToolTip for the component.
StiColor	getHeaderEndColor()	Gets header end color.
StiColor	getHeaderStartColor()	Gets header start color.
String	GetHeaderText()	Returns the band header text.
String	getHelpUrl()
int	getIndent()	indent from the left side of band for offset of data levels.
StiInteraction	getInteraction()	gets interaction options of this component.
boolean	getIsFirstInReport()
StiKeepDetails	getKeepDetails()
String	getLimitRows()
String	getLocalizedName()	Gets a localized component name.
StiMargins	getMargins()
StiComponent	getMasterComponent()	Gets or sets the master-component.
int	getMinRowsInColumn()	Gets or sets minimum count of the rows in one column.
StiMouseEnterEvent	getMouseEnterEvent()	Occurs when user enters the mouse into the area of the component in the window of viewer.
StiMouseLeaveEvent	getMouseLeaveEvent()	Occurs when user leaves the mouse out of the area of the component in the window of viewer.
boolean	getNewColumnAfter()	If the value of this property is true, then, after output of a band, a new column will be generated.
boolean	getNewColumnBefore()	If the value of this property is true, then, before output of a band, a new column will be generated.
String	getOddStyle()	Gets or sets value, indicates style of odd lines.
boolean	getPrintAtBottom()	Gets or sets value indicates that the footer is printed at bottom of page.
boolean	getPrintIfDetailEmpty()	Gets or sets value indicates that if detail is empty then the master data must be printed anyway.
StiPrintOnType	getPrintOn()	gets or sets a value which indicates on what pages component will be printed.
boolean	getPrintOnAllPages()	Gets or sets value indicates that the component is printed on all pages.
String	getReportPointer()
boolean	getResetPageNumber()	Allows to reset page number on this component.
boolean	getSkipFirst()	If the value of this property is true, then, a new page/column will be generated only starting from the second case.
ArrayList<String>	getSort()	Gets or sets the array of strings that describes rules of sorting.
StiStylesCollection	getStyles()
List<StiStyle>	getStylesList()
int	getToolboxPosition()	Gets value to sort a position in the toolbox.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setAfterPrintEvent(StiAfterPrintEvent value)
void	setBeforePrintEvent(StiBeforePrintEvent value)
void	setBreakIfLessThan(float value)
void	setCalcInvisible(boolean value)
void	setCanBreak(boolean value)	Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
void	setClickEvent(StiClickEvent value)
void	setColumnDirection(StiColumnDirection value)
void	setColumnGaps(double value)
void	setColumns(int value)
void	setColumnWidth(double value)
void	setDoubleClickEvent(StiDoubleClickEvent value)
void	setEvenStyle(String value)
void	setFilterEngine(int value)
void	setFilterMode(StiFilterMode value)
void	setFilterOn(boolean value)
void	setFilters(StiFiltersCollection value)
void	setGetBookmarkEvent(StiGetBookmarkEvent value)
void	setGetDrillDownReportEvent(StiGetDrillDownReportEvent value)
void	setGetHyperlinkEvent(StiGetHyperlinkEvent value)
void	setGetTagEvent(StiGetTagEvent value)
void	setGetToolTipEvent(StiGetToolTipEvent value)
void	setIndent(int indent)	indent from the left side of band for offset of data levels.
void	setInteraction(StiInteraction value)
void	setKeepDetails(StiKeepDetails keepDetails)
void	setLimitRows(String value)
void	setMargins(StiMargins margins)
void	setMasterComponent(StiComponent value)
void	setMinRowsInColumn(int value)
void	setMouseEnterEvent(StiMouseEnterEvent value)
void	setMouseLeaveEvent(StiMouseLeaveEvent value)
void	setNewColumnAfter(boolean value)
void	setNewColumnBefore(boolean value)
void	setOddStyle(String value)
void	setPrintAtBottom(boolean value)
void	setPrintIfDetailEmpty(boolean value)
void	setPrintOn(StiPrintOnType value)
void	setPrintOnAllPages(boolean value)
void	setReportPointer(String reportPointer)
void	setResetPageNumber(boolean value)
void	setSkipFirst(boolean value)
void	setSort(ArrayList<String> value)
void	setStyles(StiStylesCollection styles)
boolean	ShouldSerializeMargins()

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

clone, convert, doBookmark, doPointer, existDataRelation, First, getBeginRenderEvent, getBusinessObjectGuid, getCollapsed, GetColumnWidth, getComponentPlacementForChildren, getComponentType, getCount, getDataBandInfoV1, getDataBandInfoV2, getDataRelationName, getDataSourceName, getEndRenderEvent, getEvents, getFilterMethodHandler, getGetCollapsedEvent, getIsBof, getIsBusinessObjectEmpty, getIsEmpty, getIsEof, getKeepChildTogether, getKeepDetailsTogether, getKeepFooterTogether, getKeepGroupTogether, getKeepHeaderTogether, getLine, getLineThrough, getPageLine, getPosition, getPriority, getRenderingEvent, getResetDataSource, getRightToLeft, getSelectedLine, getStartNewPage, getStartNewPageIfLessThan, InvokeBeginRender, InvokeEndRender, InvokeGetCollapsed, InvokeGroupRendering, InvokeRendering, isDataSourceEmpty, Last, Next, OnBeginRender, OnEndRender, OnGetCollapsed, OnRendering, packService, Prior, renderMaster, RestoreState, saveState, setBeginRenderEvent, setBusinessObjectGuid, setCollapsed, setCountData, setDataRelationName, setDataSourceName, setEndRenderEvent, setFilterMethodHandler, setGetCollapsedEvent, setIsBof, setIsEof, setKeepChildTogether, setKeepDetailsTogether, setKeepFooterTogether, setKeepGroupTogether, setKeepHeaderTogether, setLine, setLineThrough, setPosition, setRenderingEvent, setResetDataSource, setRightToLeft, setSelectedLine, setStartNewPage, setStartNewPageIfLessThan

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

Break, getNewPageAfter, getNewPageBefore, setNewPageAfter, setNewPageBefore

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

canContainIn, getBandInfoV2, 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, checkBlockedException, CheckBlockedException, checkLargeHeight, ClearAllStates, ContainerToPage, ContainerToPage, Convert, ConvertSelectedToPage, ConvertToPage, Correct, Correct, correct2, getActualSize, getActualSize, getBlocked, getBorder, GetBorder, getBrush, GetBrush, getClientRectangle, getCollapsedValue, getCollapsingIndex, getCollapsingTreePath, 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, SortByPriority

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

addSize, AllowPrintOn, applyConditions, CheckForParentComponent, clearAllStates, ClearContents, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, decrementTop, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, fillComponentPlacement, getAlias, getAllowDelete, getAnchor, getBookmark, getBookmarkValue, getBottom, getBuilder, getComponentPlacement, GetComponentStyle, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDrillDownParameters, getEnabled, getExpressions, getForceRedrawAll, getGroupHeaderBand, GetGroupHeaderBand, getHeight, getHighlightState, getHyperlink, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInvalidateOnMouseOver, getIsCross, getIsDesigning, getIsEnabled, getIsEventEmpty, getIsExporting, getIsgetTagHandlerEmpty, getIsPrinting, getIsRendered, getIsSelected, getLevel, getLinked, getLocked, getMeasureGraphics, getPage, getPaintRectangle, getPaintRectangle, getPaintRectangle, getParent, getParentBookmark, getPlaceOnToolbox, getPointer, getPointerValue, 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, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, select, setAlias, setAnchor, setBookmark, setBookmarkValue, setCanShrink, setClientRectangle, setComponentPlacement, setComponentStyle, setConditions, setCurrentBookmark, setDelimiterComponent, setDockable, setDrillDownParameters, setEnabled, setExpressions, setGuid, setHeight, setHeightProp, setHighlightState, setHyperlink, setHyperlinkValue, setIgnoreNamingRule, setInherited, setIsRendered, setIsSelected, setLeftProp, setLinked, setLocked, setName, setPage, setPaintRectangle, setParent, setParentBookmark, setPlaceOnToolbox, setPointer, setPointerValue, 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

StiTableOfContents

public StiTableOfContents()

StiTableOfContents

public StiTableOfContents(StiRectangle rect)

Method Details

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiDataBand

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiDataBand

Throws:

JSONException

clone

public Object clone(boolean cloneProperties)

Description copied from class: StiComponent

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

Overrides:

clone in class StiContainer

Returns:

A new object that is a copy of this instance.

getDefaultClientRectangle

public StiRectangle getDefaultClientRectangle()

Description copied from class: StiBand

Gets or sets the default client area of a component.

Overrides:

getDefaultClientRectangle in class StiBand

getToolboxPosition

public int getToolboxPosition()

Description copied from class: StiDataBand

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiDataBand

getLocalizedName

public String getLocalizedName()

Description copied from class: StiDataBand

Gets a localized component name.

Overrides:

getLocalizedName in class StiDataBand

getHelpUrl

public String getHelpUrl()

getCountData

public int getCountData()

Description copied from class: StiDataBand

Gets or sets the count of rows for virtual data.

Overrides:

getCountData in class StiDataBand

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

getCanGrow

public boolean getCanGrow()

Description copied from class: StiBand

Gets or sets value indicates that this object can grow.

Specified by:

getCanGrow in interface IStiCanGrow

Overrides:

getCanGrow in class StiBand

getCanShrink

public boolean getCanShrink()

Description copied from class: StiComponent

gets or sets value which indicates that this object can shrink.

Specified by:

getCanShrink in interface IStiCanShrink

Overrides:

getCanShrink in class StiComponent

getDataSource

public StiDataSource getDataSource()

Description copied from class: StiDataBand

Get data source that is used for getting data.

Specified by:

getDataSource in interface IStiDataSource

Overrides:

getDataSource in class StiDataBand

getDataRelation

public StiDataRelation getDataRelation()

Description copied from class: StiDataBand

Get link that is used for master-detail reports rendering.

Specified by:

getDataRelation in interface IStiDataRelation

Overrides:

getDataRelation in class StiDataBand

getMasterComponent

public StiComponent getMasterComponent()

Description copied from class: StiDataBand

Gets or sets the master-component.

Specified by:

getMasterComponent in interface IStiMasterComponent

Overrides:

getMasterComponent in class StiDataBand

setMasterComponent

public void setMasterComponent(StiComponent value)

Specified by:

setMasterComponent in interface IStiMasterComponent

Overrides:

setMasterComponent in class StiDataBand

getBusinessObject

public StiBusinessObject getBusinessObject()

Description copied from class: StiDataBand

Get business object that is used for getting data.

Specified by:

getBusinessObject in interface IStiBusinessObject

Overrides:

getBusinessObject in class StiDataBand

getFilterOn

public boolean getFilterOn()

Description copied from class: StiDataBand

Gets or sets value indicates, that filter is turn on.

Specified by:

getFilterOn in interface IStiFilter

Overrides:

getFilterOn in class StiDataBand

setFilterOn

public void setFilterOn(boolean value)

Specified by:

setFilterOn in interface IStiFilter

Overrides:

setFilterOn in class StiDataBand

getFilters

public StiFiltersCollection getFilters()

Description copied from class: StiDataBand

Gets or sets the collection of data filters.

Specified by:

getFilters in interface IStiFilter

Overrides:

getFilters in class StiDataBand

setFilters

public void setFilters(StiFiltersCollection value)

Specified by:

setFilters in interface IStiFilter

Overrides:

setFilters in class StiDataBand

setFilterEngine

public void setFilterEngine(int value)

Overrides:

setFilterEngine in class StiDataBand

getFilterEngine

public int getFilterEngine()

Description copied from class: StiDataBand

Gets or sets how a filter will be applied to data - be means of the report generator or by means of changing the SQL query.

Overrides:

getFilterEngine in class StiDataBand

getFilterMode

public StiFilterMode getFilterMode()

Description copied from class: StiDataBand

Gets or sets filter mode.

Specified by:

getFilterMode in interface IStiFilter

Overrides:

getFilterMode in class StiDataBand

setFilterMode

public void setFilterMode(StiFilterMode value)

Specified by:

setFilterMode in interface IStiFilter

Overrides:

setFilterMode in class StiDataBand

getSkipFirst

public boolean getSkipFirst()

Description copied from class: StiDynamicBand

If the value of this property is true, then, a new page/column will be generated only starting from the second case.

Specified by:

getSkipFirst in interface IStiPageBreak

Overrides:

getSkipFirst in class StiDynamicBand

setSkipFirst

public void setSkipFirst(boolean value)

Specified by:

setSkipFirst in interface IStiPageBreak

Overrides:

setSkipFirst in class StiDynamicBand

getSort

public ArrayList<String> getSort()

Description copied from class: StiDataBand

Gets or sets the array of strings that describes rules of sorting.

Specified by:

getSort in interface IStiSort

Overrides:

getSort in class StiDataBand

setSort

public void setSort(ArrayList<String> value)

Specified by:

setSort in interface IStiSort

Overrides:

setSort in class StiDataBand

getNewColumnAfter

public boolean getNewColumnAfter()

Description copied from class: StiDynamicBand

If the value of this property is true, then, after output of a band, a new column will be generated.

Specified by:

getNewColumnAfter in interface IStiPageBreak

Overrides:

getNewColumnAfter in class StiDynamicBand

setNewColumnAfter

public void setNewColumnAfter(boolean value)

Specified by:

setNewColumnAfter in interface IStiPageBreak

Overrides:

setNewColumnAfter in class StiDynamicBand

getNewColumnBefore

public boolean getNewColumnBefore()

Description copied from class: StiDynamicBand

If 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:

getNewColumnBefore in interface IStiPageBreak

Overrides:

getNewColumnBefore in class StiDynamicBand

setNewColumnBefore

public void setNewColumnBefore(boolean value)

Specified by:

setNewColumnBefore in interface IStiPageBreak

Overrides:

setNewColumnBefore in class StiDynamicBand

getBreakIfLessThan

public float getBreakIfLessThan()

Description copied from class: StiDynamicBand

Gets 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:

getBreakIfLessThan in interface IStiPageBreak

Overrides:

getBreakIfLessThan in class StiDynamicBand

setBreakIfLessThan

public void setBreakIfLessThan(float value)

Specified by:

setBreakIfLessThan in interface IStiPageBreak

Overrides:

setBreakIfLessThan in class StiDynamicBand

getLimitRows

public String getLimitRows()

Overrides:

getLimitRows in class StiDataBand

Returns:

the limitRows

setLimitRows

public void setLimitRows(String value)

Overrides:

setLimitRows in class StiDataBand

Parameters:

value - the limitRows to set

getColumns

public int getColumns()

Description copied from class: StiDataBand

Gets or sets columns count.

Overrides:

getColumns in class StiDataBand

setColumns

public void setColumns(int value)

Overrides:

setColumns in class StiDataBand

getColumnDirection

public StiColumnDirection getColumnDirection()

Description copied from class: StiDataBand

Gets or sets direction of the rendeting columns.

Overrides:

getColumnDirection in class StiDataBand

setColumnDirection

public void setColumnDirection(StiColumnDirection value)

Overrides:

setColumnDirection in class StiDataBand

getColumnWidth

public double getColumnWidth()

Description copied from class: StiDataBand

Gets or sets width of column.

Overrides:

getColumnWidth in class StiDataBand

setColumnWidth

public void setColumnWidth(double value)

Overrides:

setColumnWidth in class StiDataBand

getColumnGaps

public double getColumnGaps()

Description copied from class: StiDataBand

Gets or sets distance between two columns.

Overrides:

getColumnGaps in class StiDataBand

setColumnGaps

public void setColumnGaps(double value)

Overrides:

setColumnGaps in class StiDataBand

getMinRowsInColumn

public int getMinRowsInColumn()

Description copied from class: StiDataBand

Gets or sets minimum count of the rows in one column.

Overrides:

getMinRowsInColumn in class StiDataBand

setMinRowsInColumn

public void setMinRowsInColumn(int value)

Overrides:

setMinRowsInColumn in class StiDataBand

getCalcInvisible

public boolean getCalcInvisible()

Description copied from class: StiDataBand

Gets or sets value which indicates that, when aggregate functions calculation, it is nesessary to take into consideration invisible data bands.

Overrides:

getCalcInvisible in class StiDataBand

getEvenStyle

public String getEvenStyle()

Description copied from class: StiDataBand

Gets or sets value, indicates style of even lines.

Specified by:

getEvenStyle in interface IStiOddEvenStyles

Overrides:

getEvenStyle in class StiDataBand

getOddStyle

public String getOddStyle()

Description copied from class: StiDataBand

Gets or sets value, indicates style of odd lines.

Specified by:

getOddStyle in interface IStiOddEvenStyles

Overrides:

getOddStyle in class StiDataBand

setCalcInvisible

public void setCalcInvisible(boolean value)

Overrides:

setCalcInvisible in class StiDataBand

setEvenStyle

public void setEvenStyle(String value)

Specified by:

setEvenStyle in interface IStiOddEvenStyles

Overrides:

setEvenStyle in class StiDataBand

setOddStyle

public void setOddStyle(String value)

Specified by:

setOddStyle in interface IStiOddEvenStyles

Overrides:

setOddStyle in class StiDataBand

setKeepDetails

public void setKeepDetails(StiKeepDetails keepDetails)

Overrides:

setKeepDetails in class StiDataBand

getKeepDetails

public StiKeepDetails getKeepDetails()

Overrides:

getKeepDetails in class StiDataBand

getPrintIfDetailEmpty

public boolean getPrintIfDetailEmpty()

Description copied from class: StiDataBand

Gets or sets value indicates that if detail is empty then the master data must be printed anyway.

Specified by:

getPrintIfDetailEmpty in interface IStiPrintIfDetailEmpty

Overrides:

getPrintIfDetailEmpty in class StiDataBand

getPrintOnAllPages

public boolean getPrintOnAllPages()

Description copied from class: StiDataBand

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

Specified by:

getPrintOnAllPages in interface IStiPrintOnAllPages

Overrides:

getPrintOnAllPages in class StiDataBand

setPrintIfDetailEmpty

public void setPrintIfDetailEmpty(boolean value)

Specified by:

setPrintIfDetailEmpty in interface IStiPrintIfDetailEmpty

Overrides:

setPrintIfDetailEmpty in class StiDataBand

setPrintOnAllPages

public void setPrintOnAllPages(boolean value)

Specified by:

setPrintOnAllPages in interface IStiPrintOnAllPages

Overrides:

setPrintOnAllPages in class StiDataBand

getPrintAtBottom

public boolean getPrintAtBottom()

Description copied from class: StiDynamicBand

Gets or sets value indicates that the footer is printed at bottom of page.

Specified by:

getPrintAtBottom in interface IStiPrintAtBottom

Overrides:

getPrintAtBottom in class StiDynamicBand

setPrintAtBottom

public void setPrintAtBottom(boolean value)

Specified by:

setPrintAtBottom in interface IStiPrintAtBottom

Overrides:

setPrintAtBottom in class StiDynamicBand

getPrintOn

public StiPrintOnType getPrintOn()

Description copied from class: StiComponent

gets or sets a value which indicates on what pages component will be printed.

Specified by:

getPrintOn in interface IStiPrintOn

Overrides:

getPrintOn in class StiComponent

setPrintOn

public void setPrintOn(StiPrintOnType value)

Specified by:

setPrintOn in interface IStiPrintOn

Overrides:

setPrintOn in class StiComponent

getResetPageNumber

public boolean getResetPageNumber()

Description copied from class: StiDataBand

Allows to reset page number on this component.

Specified by:

getResetPageNumber in interface IStiResetPageNumber

Overrides:

getResetPageNumber in class StiDataBand

setResetPageNumber

public void setResetPageNumber(boolean value)

Specified by:

setResetPageNumber in interface IStiResetPageNumber

Overrides:

setResetPageNumber in class StiDataBand

getInteraction

public StiInteraction getInteraction()

Description copied from class: StiComponent

gets interaction options of this component.

Specified by:

getInteraction in interface IStiInteraction

Overrides:

getInteraction in class StiComponent

setInteraction

public void setInteraction(StiInteraction value)

Specified by:

setInteraction in interface IStiInteraction

Overrides:

setInteraction in class StiComponent

getAfterPrintEvent

public StiAfterPrintEvent getAfterPrintEvent()

Description copied from class: StiComponent

Occurs after the component printing.

Overrides:

getAfterPrintEvent in class StiComponent

getBeforePrintEvent

public StiBeforePrintEvent getBeforePrintEvent()

Description copied from class: StiComponent

Occurs before printing of the component.

Overrides:

getBeforePrintEvent in class StiComponent

getClickEvent

public StiClickEvent getClickEvent()

Description copied from class: StiComponent

Occurs when user clicks on the component in the window of viewer.

Overrides:

getClickEvent in class StiComponent

getDoubleClickEvent

public StiDoubleClickEvent getDoubleClickEvent()

Description copied from class: StiComponent

Occurs when user double clicks on the component in the window of viewer.

Overrides:

getDoubleClickEvent in class StiComponent

getGetBookmarkEvent

public StiGetBookmarkEvent getGetBookmarkEvent()

Description copied from class: StiComponent

Occurs when getting of the Bookmark for the component.

Overrides:

getGetBookmarkEvent in class StiComponent

getGetDrillDownReportEvent

public StiGetDrillDownReportEvent getGetDrillDownReportEvent()

Description copied from class: StiComponent

Occurs when it is required to get a report for the Drill-Down operation.

Overrides:

getGetDrillDownReportEvent in class StiComponent

getGetHyperlinkEvent

public StiGetHyperlinkEvent getGetHyperlinkEvent()

Description copied from class: StiComponent

Occurs when getting Hyperlink for the component.

Overrides:

getGetHyperlinkEvent in class StiComponent

getGetTagEvent

public StiGetTagEvent getGetTagEvent()

Description copied from class: StiComponent

Occurs when getting a Tag for a component.

Overrides:

getGetTagEvent in class StiComponent

getGetToolTipEvent

public StiGetToolTipEvent getGetToolTipEvent()

Description copied from class: StiComponent

Occurs when getting the ToolTip for the component.

Overrides:

getGetToolTipEvent in class StiComponent

getMouseEnterEvent

public StiMouseEnterEvent getMouseEnterEvent()

Description copied from class: StiComponent

Occurs when user enters the mouse into the area of the component in the window of viewer.

Overrides:

getMouseEnterEvent in class StiComponent

getMouseLeaveEvent

public StiMouseLeaveEvent getMouseLeaveEvent()

Description copied from class: StiComponent

Occurs when user leaves the mouse out of the area of the component in the window of viewer.

Overrides:

getMouseLeaveEvent in class StiComponent

setAfterPrintEvent

public void setAfterPrintEvent(StiAfterPrintEvent value)

Overrides:

setAfterPrintEvent in class StiComponent

setBeforePrintEvent

public void setBeforePrintEvent(StiBeforePrintEvent value)

Overrides:

setBeforePrintEvent in class StiComponent

setClickEvent

public void setClickEvent(StiClickEvent value)

Overrides:

setClickEvent in class StiComponent

setDoubleClickEvent

public void setDoubleClickEvent(StiDoubleClickEvent value)

Overrides:

setDoubleClickEvent in class StiComponent

setGetBookmarkEvent

public void setGetBookmarkEvent(StiGetBookmarkEvent value)

Overrides:

setGetBookmarkEvent in class StiComponent

setGetDrillDownReportEvent

public void setGetDrillDownReportEvent(StiGetDrillDownReportEvent value)

Overrides:

setGetDrillDownReportEvent in class StiComponent

setGetHyperlinkEvent

public void setGetHyperlinkEvent(StiGetHyperlinkEvent value)

Overrides:

setGetHyperlinkEvent in class StiComponent

setGetTagEvent

public void setGetTagEvent(StiGetTagEvent value)

Overrides:

setGetTagEvent in class StiComponent

setGetToolTipEvent

public void setGetToolTipEvent(StiGetToolTipEvent value)

Overrides:

setGetToolTipEvent in class StiComponent

setMouseEnterEvent

public void setMouseEnterEvent(StiMouseEnterEvent value)

Overrides:

setMouseEnterEvent in class StiComponent

setMouseLeaveEvent

public void setMouseLeaveEvent(StiMouseLeaveEvent value)

Overrides:

setMouseLeaveEvent in class StiComponent

getHeaderStartColor

public StiColor getHeaderStartColor()

Description copied from class: StiDataBand

Gets header start color.

Overrides:

getHeaderStartColor in class StiDataBand

getHeaderEndColor

public StiColor getHeaderEndColor()

Description copied from class: StiDataBand

Gets header end color.

Overrides:

getHeaderEndColor in class StiDataBand

GetHeaderText

public String GetHeaderText()

Description copied from class: StiDataBand

Returns the band header text.

Overrides:

GetHeaderText in class StiDataBand

Returns:

Band header text.

CreateNew

public StiComponent CreateNew()

getStylesList

public List<StiStyle> getStylesList()

getIsFirstInReport

public boolean getIsFirstInReport()

getStyles

public StiStylesCollection getStyles()

Returns:

the styles

setStyles

public void setStyles(StiStylesCollection styles)

Parameters:

styles - the styles to set

getIndent

public int getIndent()

indent from the left side of band for offset of data levels.

Returns:

the indent

setIndent

public void setIndent(int indent)

indent from the left side of band for offset of data levels.

Parameters:

indent - the indent to set

getReportPointer

public String getReportPointer()

Returns:

the reportPointer

setReportPointer

public void setReportPointer(String reportPointer)

Parameters:

reportPointer - the reportPointer to set

getMargins

public StiMargins getMargins()

Returns:

the margins

setMargins

public void setMargins(StiMargins margins)

Parameters:

margins - the margins to set

ShouldSerializeMargins

public boolean ShouldSerializeMargins()