com.stimulsoft.report.components
Class StiPage

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.complexcomponents.StiPanel
                          com.stimulsoft.report.components.StiPage

All Implemented Interfaces:

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

Direct Known Subclasses:

StiForm

public class StiPage
extends StiPanel
implements IStiResetPageNumber, IStiStateSaveRestore

Copyright Stimulsoft *

Field Summary

boolean	drillDownPageGuid
static StiPage	EMPTY_PAGE
StiEventHandler	handlerBeginRender
StiEventHandler	handlerEndRender
StiEventHandler	handlerOnColumnBeginRender
StiEventHandler	handlerOnColumnEndRender
StiEventHandler	handlerOnGetExcelSheet
StiEventHandler	handlerRendering
StiMargins	margins
StiPageInfoV2	pageInfoV2
java.lang.Integer	segmentPerHeight
java.lang.Integer	segmentPerWidth
boolean	skip

Fields inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer

border, brush, collapsingIndex, components, ParentComponentIsBand, ParentComponentIsCrossBand

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

canGrow, canShrink, componentPlacement, conditions, currentPointer, expressions, interaction, isRendered, page, parent, parentBookmark, parentPointer, top, width

Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

StiPage()
Creates a new component of the type StiPage.

StiPage(StiReport report)
Creates a new component of the type StiPage.

Method Summary

void	ClearPage()
java.lang.Object	clone() Creates a new object that is a copy of the current instance.
java.lang.Object	clone(boolean cloneProperties, boolean cloneComponents) Creates a new object that is a copy of the current instanc * *
void	convert(StiUnit oldUnit, StiUnit newUnit) Converts a component out of one unit into another * *
double	ConvertFromHInches(StiUnit unit, double value)
double	ConvertToHInches(StiUnit unit, double value)
StiRectangle	convertToHInches(StiUnit unit, StiRectangle rect)
void	disposeImagesAndClearComponents()
StiBeginRenderEvent	getBeginRenderEvent() Occurs when when a page begins to render.
double	getBottom() Gets bottom margin.
java.lang.String	getCacheGuid() Gets or sets a cache guid of page.
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 a value which indicates that this object can grow.
boolean	getCanShrink() gets or sets value which indicates that this object can shrink.
StiRectangle	getClientRectangle() Gets or sets the client area of a component.
StiColumnBeginRenderEvent	getColumnBeginRenderEvent() Occurs when start render column.
StiColumnEndRenderEvent	getColumnEndRenderEvent() Occurs when end render column.
java.lang.String	getComponentPlacementForChildren()
int	GetComponentsCount()
int	getCurrentHeightSegment() Gets or sets the current height of a page segment.
int	getCurrentWidthSegment() Gets or sets the current width of a page segment.
boolean	getDenyDrawSegmentMode() Internal use only.
StiRectangle	getDisplayRectangle() Gets or sets a rectangle of the component which it fills.
StiDockStyle	getDockStyle() Gets or sets a type of the component docking.
boolean	getDrillDownActivated()
StiEndRenderEvent	getEndRenderEvent() Occurs when when a page ends to render.
StiEngineVersion	getEngineVersion()
StiEventsCollection	getEvents() Return events collection of this component.
StiExcelSheetExpression	getExcelSheet() Gets or sets an expression used for generation name of excel sheet.
java.lang.String	getExcelSheetValue() Gets or sets name of excel sheet.
StiGetExcelSheetEvent	getGetExcelSheetEvent() Occurs when the ExcelSheet is calculated.
double	getGridSize() Gets grid size in the unit.
boolean	getGrowToHeight() gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.
java.lang.String	getGuid() gets or sets a guid of component.
double	getHeight() Gets or sets height.
boolean	getIsAutomaticDock() Gets value indicates that this is an automatic docking.
boolean	getIsPrinted()
boolean	getLargeHeight() Gets or sets value indicates that this page has in designer large height.
double	getLargeHeightAutoFactor() large height factor for LargeHeightAuto mode of this page.
int	getLargeHeightFactor() Gets or sets large height factor for LargeHeight property of this page.
double	getLeft() Gets or sets left margin.
boolean	getLinked() gets or sets a value which indicates whether the object snap to the container is turned on.
java.lang.String	getLocalizedName() Gets a localized component name.
boolean	getLocked() gets or sets a value which indicates that moving is locked.
boolean	getLockHighlight()
StiMargins	getMargins() Gets or sets page margins.
StiSize	getMaxSize() gets or sets maximal size.
StiSize	getMinSize() gets or sets minimal size.
java.lang.Boolean	getMirrorMargins() value indicates that mirror margins are set.
java.lang.String	getName() Gets or sets a component name.
int	getNumberOfCopies() Gets or sets a value of number of copies of the current page.
StiRectangle	getOffsetRectangle() Gets or sets offset of the selected components on the page.
StiPageOrientation	getOrientation() Gets or sets page orientation.
StiPage	getPage() Deprecated.
double	getPageHeight() Gets or sets the total height of the page.
StiPageInfoV2	getPageInfoV2()
double	getPageWidth() Gets or sets the total width of the page.
StiPaperKind	getPaperSize() Gets or sets the page size.
StiPaperSourceKind	getPaperSourceFirstPage() Gets or sets the paper source for first page.
java.lang.String	getPaperSourceOfFirstPage() Gets or sets the paper source for first page.
java.lang.String	getPaperSourceOfOtherPages() Gets or sets the paper source for first page.
StiPaperSourceKind	getPaperSourceOtherPages() Gets or sets the paper source for other pages.
StiContainer	getParent() gets or sets the container in which an object is located.
boolean	getPrintable() gets or sets a value which indicates whether a component is printable or not.
boolean	getPrintHeadersFootersFromPreviousPage() Gets or sets value which indicates that, on this page, it is necessary to print headers and footers of the previous page.
StiPrintOnType	getPrintOn() gets or sets a value which indicates on what pages component will be printed.
boolean	getPrintOnPreviousPage() Gets or sets value that indicates that the page will start to be rendered on the free space of the previous page.
StiRenderingEvent	getRenderingEvent() Occurs when a page rendering.
StiReport	getReport() Gets or sets the report in which the page is located.
StiUnit	getReportUnit() Used for save/load page.
boolean	getResetPageNumber() Allows to reset page number on this page.
StiEnumSet<StiRestrictions>	getRestrictions() gets or sets value which indicates the restrictions of a component.
double	getRight() Gets right margin.
int	getSegmentPerHeight() Gets or sets the number of segments per height.
int	getSegmentPerWidth() Gets or sets the number of segments per width.
java.util.ArrayList<StiComponent>	getSelectedComponents()
StiRectangle	getSelectedRectangle() Internal use only.
StiEnumSet<StiShiftMode>	getShiftMode() gets or sets a value which indicates the shift mode of a component.
boolean	getSkip() Gets or sets value, indicates that, when rendering of the report, this page of the report is to be skipped.
int	getStopBeforePrint() Gets or sets the page number.
boolean	getStretchToPrintArea() Gets or sets value, indicates that, when printing, a page stretches into print area.
java.lang.Object	getTagValue() gets or sets tag of a component.
boolean	getTitleBeforeHeader() Gets or sets value, indicates that it is necessary to put the report title before the page header.
double	getTop() Gets or sets top margin.
StiUnit	getUnit()
boolean	getUnlimitedBreakable() Gets or sets value indicates that when printing of multiple-sheet cross-reports, columns and strings are to be broken.
boolean	getUnlimitedHeight() Gets or sets value, indicates that the page has an unlimited height.
boolean	getUnlimitedWidth() Gets or sets value, indicates that the page has an unlimited width.
boolean	getUseParentStyles() gets or sets a value which indicates that this component must use styles from parent component.
StiWatermark	getWatermark() Gets or sets watermark of the page.
double	getWidth() Gets or sets width.
double	getZoom() Gets zoom of a report.
void	InvokeBeginRender() Raises the BeginRender event for this component.
void	InvokeColumnBeginRender() Raises the ColumnBeginRender event for this component.
void	InvokeColumnBeginRender(java.lang.Object sender, StiEventHandlerArgs e) Raises the ColumnBeginRender event for this component.
void	InvokeColumnEndRender() Raises the ColumnEndRender event for this component.
void	InvokeColumnEndRender(java.lang.Object sender, StiEventHandlerArgs e) Raises the ColumnBeginRender event for this component.
void	InvokeEndRender() Raises the EndRender event for this component.
void	InvokeGetExcelSheet(StiComponent sender, StiGetExcelSheetEventArgs e) Raises the GetExcelSheet event.
void	InvokeRendering() Raises the Rendering event for this component.
boolean	isPage()
void	LoadFromJsonObject(JSONObject jObject)
void	NewCacheGuid()
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setBeginRenderEvent(StiBeginRenderEvent value)
void	setCanBreak(boolean value)
void	setCanGrow(boolean value)
void	setCanShrink(boolean value)
void	setClientRectangle(StiRectangle value)
void	setColumnBeginRenderEvent(StiColumnBeginRenderEvent value)
void	setColumnEndRenderEvent(StiColumnEndRenderEvent value)
void	setCurrentHeightSegment(int value)
void	setCurrentWidthSegment(int value)
void	setDenyDrawSegmentMode(boolean value)
void	setDockStyle(StiDockStyle value)
void	setDrillDownActivated(boolean value)
void	setEndRenderEvent(StiEndRenderEvent value)
void	setExcelSheet(StiExcelSheetExpression value)
void	setExcelSheetValue(java.lang.String value)
void	setGetExcelSheetEvent(StiGetExcelSheetEvent value)
void	setGrowToHeight(boolean value)
void	setHeight(double value)
void	setIsPrinted(boolean value)
void	setLargeHeight(boolean value)
void	setLargeHeightAutoFactor(double largeHeightAutoFactor) large height factor for LargeHeightAuto mode of this page.
void	setLargeHeightFactor(int value)
void	setLeft(double value)
void	setLinked(boolean value)
void	setLocked(boolean value)
void	setLockHighlight(boolean value)
void	setMargins(StiMargins value)
void	setMaxSize(StiSize value)
void	setMinSize(StiSize value)
void	setMirrorMargins(java.lang.Boolean mirrorMargins) value indicates that mirror margins are set.
void	setNumberOfCopies(int value)
void	setOffsetRectangle(StiRectangle value)
void	setOrientation(StiPageOrientation value)
void	setPage(StiPage value)
void	setPageHeight(double value)
void	setPageWidth(double value)
void	setPaperSize(StiPaperKind value)
void	setPaperSourceFirstPage(StiPaperSourceKind value)
void	setPaperSourceOfFirstPage(java.lang.String value)
void	setPaperSourceOfOtherPages(java.lang.String value)
void	setPaperSourceOtherPages(StiPaperSourceKind value)
void	setParent(StiContainer value)
void	setPrintable(boolean value)
void	setPrintHeadersFootersFromPreviousPage(boolean value)
void	setPrintOn(StiPrintOnType value)
void	setPrintOnPreviousPage(boolean value)
void	setRenderingEvent(StiRenderingEvent value)
void	setReport(StiReport value)
void	setReportUnit(StiUnit value)
void	setResetPageNumber(boolean value)
void	setRestrictions(StiEnumSet<StiRestrictions> value)
void	setSegmentPerHeight(int value)
void	setSegmentPerWidth(int value)
void	setSelectedRectangle(StiRectangle value)
void	setShiftMode(StiEnumSet<StiShiftMode> value)
void	setSkip(boolean value)
void	setStopBeforePrint(int value)
void	setStretchToPrintArea(boolean value)
void	setTitleBeforeHeader(boolean titleBeforeHeader)
void	setTop(double value)
void	setUnlimitedBreakable(boolean value)
void	setUnlimitedHeight(boolean value)
void	setUnlimitedWidth(boolean value)
void	setUseParentStyles(boolean value)
void	setWatermark(StiWatermark value)
void	setWidth(double value)
boolean	TitleBeforeHeader()

Methods inherited from class com.stimulsoft.report.components.complexcomponents.StiPanel

addComponent, getColumnGaps, getColumns, getColumnWidth, getColumnWidth2, getColumnWidthM, getPriority, getRightToLeft, getToolboxPosition, setColumnGaps, setColumns, setColumnWidth, setRightToLeft

Methods inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer

AlignTo, AlignToGrid, AlignToGrid, Break, BringToFront, ChangePosition, checkLargeHeight, ClearAllStates, clone, ContainerToPage, ContainerToPage, Convert, ConvertSelectedToPage, ConvertToPage, Correct, Correct, correct2, getActualSize, getActualSize, getBorder, GetBorder, getBrush, GetBrush, getCollapsedValue, getCollapsingIndex, getCollapsingTreePath, getComponents, GetComponents, GetComponentsList, getComponentsSelectedRectangle, getComponentStyle, getComponentType, GetConditions, getContainerInfoV1, getContainerInfoV2, GetContainerInRect, GetContainerInRect2, getDefaultClientRectangle, GetDockableComponent, GetDockStyle, GetFirstSelectableCompanent, GetFont, getHasSelected, GetHorAlignment, GetIncorrect, GetIncorrect, getIncorrect2, getLocalizedCategory, GetMaxSize, GetRectangle, GetSelectedComponents, GetSelectedComponentsWithChilds, GetSelectedRectangleWithChilds, GetTextBrush, GetTextFormat, GetTextHorAlignment, GetVertAlignment, GetWordWrap, GrowFont, InvertComponentsPosition, isForceSerializeToReport, MakeHorizontalSpacingEqual, MakeSameHeight, MakeSameSize, MakeSameWidth, MakeVerticalSpacingEqual, MoveBackward, MoveComponentsToPage, MoveForward, Normalize, OffsetLocation, 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, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearContents, ComponentToPage, ComponentToPage, ComponentToPage, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, fillComponentPlacement, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getClickEvent, getComponentPlacement, getConditions, getContainer, getCurrentBookmark, getDataBand, 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, getIsCross, getIsDesigning, getIsEnabled, getIsEventEmpty, getIsExporting, getIsgetTagHandlerEmpty, getIsPrinting, getIsRendered, getIsSelected, getLevel, getMeasureGraphics, getMouseEnterEvent, getMouseLeaveEvent, getPaintRectangle, getPaintRectangle, getPaintRectangle, getParentBookmark, getPlaceOnToolbox, getPointer, getPointerValue, getQuickInfo, getRenderedCount, getSelectionTick, getSelectRectangle, getServiceCategory, getServiceType, getShift, getShowQuickButtons, getTag, getTagStrValue, getToolTip, getToolTipValue, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeClick, InvokeDoubleClick, invokeEvents, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, isAutomaticDock, isDesigning, isExportAsImage, IsParentSelect, NewGuid, OnRemoveComponent, packService, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, select, setAfterPrintEvent, setAlias, setAnchor, setBeforePrintEvent, setBookmark, setBookmarkValue, setClickEvent, setComponentPlacement, setComponentStyle, setConditions, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDoubleClickEvent, setDrillDownParameters, setEnabled, setExpressions, setgetBookmarkEvent, setgetDrillDownReportEvent, setgetHyperlinkEvent, setgetTagEvent, setgetToolTipEvent, setGuid, setHeightProp, setHighlightState, setHyperlink, setHyperlinkValue, setIgnoreNamingRule, setInherited, setInteraction, setIsRendered, setIsSelected, setLeftProp, setMouseEnterEvent, setMouseLeaveEvent, setName, setPaintRectangle, setParentBookmark, setPlaceOnToolbox, setPointer, setPointerValue, setRenderedCount, SetReportVariables, setSelectionTick, setSelectRectangle, setShift, setShowQuickButtons, setStates, setTag, setTagValue, setToolTip, setToolTipValue, setTopProp, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stimulsoft.report.IStiStateSaveRestore

clearAllStates, restoreState, saveState

Methods inherited from interface com.stimulsoft.report.components.interfaces.IStiBreakable

Break

Methods inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

getReference, setReference

Field Detail

EMPTY_PAGE

public static StiPage EMPTY_PAGE

margins

public StiMargins margins

skip

public boolean skip

segmentPerWidth

public java.lang.Integer segmentPerWidth

segmentPerHeight

public java.lang.Integer segmentPerHeight

pageInfoV2

public StiPageInfoV2 pageInfoV2

drillDownPageGuid

public boolean drillDownPageGuid

handlerBeginRender

public StiEventHandler handlerBeginRender

handlerRendering

public StiEventHandler handlerRendering

handlerEndRender

public StiEventHandler handlerEndRender

handlerOnColumnBeginRender

public StiEventHandler handlerOnColumnBeginRender

handlerOnColumnEndRender

public StiEventHandler handlerOnColumnEndRender

handlerOnGetExcelSheet

public StiEventHandler handlerOnGetExcelSheet

Constructor Detail

StiPage

public StiPage()

Creates a new component of the type StiPage.

StiPage

public StiPage(StiReport report)

Creates a new component of the type StiPage.

Parameters:

report - The report in which a page will be added.

Method Detail

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiPanel

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiPanel

Throws:

JSONException

getResetPageNumber

public boolean getResetPageNumber()

Allows to reset page number on this page.

Specified by:

getResetPageNumber in interface IStiResetPageNumber

setResetPageNumber

public void setResetPageNumber(boolean value)

Specified by:

setResetPageNumber in interface IStiResetPageNumber

ConvertToHInches

public final double ConvertToHInches(StiUnit unit,
                                     double value)

ConvertFromHInches

public final double ConvertFromHInches(StiUnit unit,
                                       double value)

convertToHInches

public final StiRectangle convertToHInches(StiUnit unit,
                                           StiRectangle rect)

convert

public void convert(StiUnit oldUnit,
                    StiUnit newUnit)

Converts a component out of one unit into another * *

Specified by:

convert in interface IStiUnitConvert

Overrides:

convert in class StiContainer

Parameters:

oldUnit - Old units.

newUnit - New units.

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

setCanShrink

public void setCanShrink(boolean value)

Specified by:

setCanShrink in interface IStiCanShrink

Overrides:

setCanShrink in class StiComponent

clone

public java.lang.Object clone(boolean cloneProperties,
                              boolean cloneComponents)

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.

getCanGrow

public boolean getCanGrow()

Description copied from class: StiComponent

gets or sets a value which indicates that this object can grow.

Specified by:

getCanGrow in interface IStiCanGrow

Overrides:

getCanGrow in class StiComponent

setCanGrow

public void setCanGrow(boolean value)

Specified by:

setCanGrow in interface IStiCanGrow

Overrides:

setCanGrow in class StiComponent

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

getCanBreak

public boolean getCanBreak()

Description copied from class: StiPanel

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 StiPanel

setCanBreak

public void setCanBreak(boolean value)

Specified by:

setCanBreak in interface IStiBreakable

Overrides:

setCanBreak in class StiPanel

getIsAutomaticDock

public boolean getIsAutomaticDock()

Gets value indicates that this is an automatic docking.

getDockStyle

public StiDockStyle getDockStyle()

Gets or sets a type of the component docking.

Overrides:

getDockStyle in class StiComponent

setDockStyle

public void setDockStyle(StiDockStyle value)

Overrides:

setDockStyle in class StiComponent

getMinSize

public StiSize getMinSize()

Description copied from class: StiComponent

gets or sets minimal size.

Overrides:

getMinSize in class StiComponent

setMinSize

public void setMinSize(StiSize value)

Overrides:

setMinSize in class StiComponent

getMaxSize

public StiSize getMaxSize()

Description copied from class: StiComponent

gets or sets maximal size.

Overrides:

getMaxSize in class StiComponent

setMaxSize

public void setMaxSize(StiSize value)

Overrides:

setMaxSize in class StiComponent

getLeft

public double getLeft()

Gets or sets left margin.

Overrides:

getLeft in class StiComponent

setLeft

public void setLeft(double value)

Overrides:

setLeft in class StiComponent

getTop

public double getTop()

Gets or sets top margin.

Overrides:

getTop in class StiComponent

setTop

public void setTop(double value)

Overrides:

setTop in class StiComponent

getWidth

public double getWidth()

Gets or sets width.

Overrides:

getWidth in class StiComponent

setWidth

public void setWidth(double value)

Overrides:

setWidth in class StiComponent

getHeight

public double getHeight()

Gets or sets height.

Overrides:

getHeight in class StiComponent

setHeight

public void setHeight(double value)

Overrides:

setHeight in class StiComponent

getRight

public double getRight()

Gets right margin.

Overrides:

getRight in class StiComponent

getBottom

public double getBottom()

Gets bottom margin.

Overrides:

getBottom in class StiComponent

getClientRectangle

public StiRectangle getClientRectangle()

Gets or sets the client area of a component.

Overrides:

getClientRectangle in class StiContainer

setClientRectangle

public void setClientRectangle(StiRectangle value)

Overrides:

setClientRectangle in class StiComponent

getDisplayRectangle

public StiRectangle 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:

getDisplayRectangle in class StiComponent

getDenyDrawSegmentMode

public final boolean getDenyDrawSegmentMode()

Internal use only.

setDenyDrawSegmentMode

public final void setDenyDrawSegmentMode(boolean value)

getSelectedRectangle

public final StiRectangle getSelectedRectangle()

Internal use only.

setSelectedRectangle

public final void setSelectedRectangle(StiRectangle value)

getSelectedComponents

public final java.util.ArrayList<StiComponent> getSelectedComponents()

getUseParentStyles

public boolean getUseParentStyles()

Description copied from class: StiComponent

gets or sets a value which indicates that this component must use styles from parent component.

Overrides:

getUseParentStyles in class StiComponent

setUseParentStyles

public void setUseParentStyles(boolean value)

Overrides:

setUseParentStyles in class StiComponent

getGrowToHeight

public boolean getGrowToHeight()

Description copied from class: StiComponent

gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.

Specified by:

getGrowToHeight in interface IStiGrowToHeight

Overrides:

getGrowToHeight in class StiComponent

setGrowToHeight

public void setGrowToHeight(boolean value)

Specified by:

setGrowToHeight in interface IStiGrowToHeight

Overrides:

setGrowToHeight in class StiComponent

getShiftMode

public StiEnumSet<StiShiftMode> getShiftMode()

Description copied from class: StiComponent

gets or sets a value which indicates the shift mode of a component.

Specified by:

getShiftMode in interface IStiShift

Overrides:

getShiftMode in class StiComponent

setShiftMode

public void setShiftMode(StiEnumSet<StiShiftMode> value)

Specified by:

setShiftMode in interface IStiShift

Overrides:

setShiftMode in class StiComponent

getPrintable

public boolean getPrintable()

Description copied from class: StiComponent

gets or sets a value which indicates whether a component is printable or not.

Overrides:

getPrintable in class StiComponent

setPrintable

public void setPrintable(boolean value)

Overrides:

setPrintable in class StiComponent

getEvents

public StiEventsCollection getEvents()

Return events collection of this component.

Overrides:

getEvents in class StiComponent

getLocalizedName

public java.lang.String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiPanel

getPage

@Deprecated
public StiPage getPage()

Deprecated.

Description copied from class: StiComponent

gets or sets the page on which an object is located.

Overrides:

getPage in class StiComponent

setPage

public void setPage(StiPage value)

Overrides:

setPage in class StiComponent

getParent

public StiContainer getParent()

Description copied from class: StiComponent

gets or sets the container in which an object is located.

Overrides:

getParent in class StiComponent

setParent

public void setParent(StiContainer value)

Overrides:

setParent in class StiComponent

getRestrictions

public StiEnumSet<StiRestrictions> getRestrictions()

Description copied from class: StiComponent

gets or sets value which indicates the restrictions of a component.

Overrides:

getRestrictions in class StiComponent

setRestrictions

public void setRestrictions(StiEnumSet<StiRestrictions> value)

Overrides:

setRestrictions in class StiComponent

InvokeBeginRender

public final void InvokeBeginRender()

Raises the BeginRender event for this component.

Overrides:

InvokeBeginRender in class StiComponent

getBeginRenderEvent

public StiBeginRenderEvent getBeginRenderEvent()

Occurs when when a page begins to render.

setBeginRenderEvent

public void setBeginRenderEvent(StiBeginRenderEvent value)

InvokeRendering

public final void InvokeRendering()

Raises the Rendering event for this component.

getRenderingEvent

public StiRenderingEvent getRenderingEvent()

Occurs when a page rendering.

setRenderingEvent

public void setRenderingEvent(StiRenderingEvent value)

InvokeEndRender

public final void InvokeEndRender()

Raises the EndRender event for this component.

Overrides:

InvokeEndRender in class StiComponent

getEndRenderEvent

public StiEndRenderEvent getEndRenderEvent()

Occurs when when a page ends to render.

setEndRenderEvent

public void setEndRenderEvent(StiEndRenderEvent value)

InvokeColumnBeginRender

public final void InvokeColumnBeginRender()

Raises the ColumnBeginRender event for this component.

InvokeColumnBeginRender

public final void InvokeColumnBeginRender(java.lang.Object sender,
                                          StiEventHandlerArgs e)

Raises the ColumnBeginRender event for this component.

getColumnBeginRenderEvent

public StiColumnBeginRenderEvent getColumnBeginRenderEvent()

Occurs when start render column.

setColumnBeginRenderEvent

public void setColumnBeginRenderEvent(StiColumnBeginRenderEvent value)

InvokeColumnEndRender

public final void InvokeColumnEndRender()

Raises the ColumnEndRender event for this component.

InvokeColumnEndRender

public final void InvokeColumnEndRender(java.lang.Object sender,
                                        StiEventHandlerArgs e)

Raises the ColumnBeginRender event for this component.

getColumnEndRenderEvent

public StiColumnEndRenderEvent getColumnEndRenderEvent()

Occurs when end render column.

setColumnEndRenderEvent

public void setColumnEndRenderEvent(StiColumnEndRenderEvent value)

InvokeGetExcelSheet

public void InvokeGetExcelSheet(StiComponent sender,
                                StiGetExcelSheetEventArgs e)

Raises the GetExcelSheet event.

getGetExcelSheetEvent

public StiGetExcelSheetEvent getGetExcelSheetEvent()

Occurs when the ExcelSheet is calculated.

setGetExcelSheetEvent

public void setGetExcelSheetEvent(StiGetExcelSheetEvent value)

getExcelSheetValue

public final java.lang.String getExcelSheetValue()

Gets or sets name of excel sheet.

setExcelSheetValue

public final void setExcelSheetValue(java.lang.String value)

getExcelSheet

public StiExcelSheetExpression getExcelSheet()

Gets or sets an expression used for generation name of excel sheet.

setExcelSheet

public void setExcelSheet(StiExcelSheetExpression value)

getIsPrinted

public final boolean getIsPrinted()

setIsPrinted

public final void setIsPrinted(boolean value)

getZoom

public double getZoom()

Gets zoom of a report.

getGridSize

public double getGridSize()

Gets grid size in the unit.

getPrintOnPreviousPage

public boolean getPrintOnPreviousPage()

Gets or sets value that indicates that the page will start to be rendered on the free space of the previous page.

setPrintOnPreviousPage

public void setPrintOnPreviousPage(boolean value)

getPrintHeadersFootersFromPreviousPage

public boolean getPrintHeadersFootersFromPreviousPage()

Gets or sets value which indicates that, on this page, it is necessary to print headers and footers of the previous page.

setPrintHeadersFootersFromPreviousPage

public void setPrintHeadersFootersFromPreviousPage(boolean value)

getPaperSize

public StiPaperKind getPaperSize()

Gets or sets the page size.

setPaperSize

public void setPaperSize(StiPaperKind value)

getPaperSourceFirstPage

public StiPaperSourceKind getPaperSourceFirstPage()

Gets or sets the paper source for first page. Some printers does not support this feature.

setPaperSourceFirstPage

public void setPaperSourceFirstPage(StiPaperSourceKind value)

getPaperSourceOfFirstPage

public java.lang.String getPaperSourceOfFirstPage()

Gets or sets the paper source for first page. Some printers does not support this feature.

setPaperSourceOfFirstPage

public void setPaperSourceOfFirstPage(java.lang.String value)

getPaperSourceOtherPages

public StiPaperSourceKind getPaperSourceOtherPages()

Gets or sets the paper source for other pages. Some printers does not support this feature.

setPaperSourceOtherPages

public void setPaperSourceOtherPages(StiPaperSourceKind value)

getPaperSourceOfOtherPages

public java.lang.String getPaperSourceOfOtherPages()

Gets or sets the paper source for first page. Some printers does not support this feature.

setPaperSourceOfOtherPages

public void setPaperSourceOfOtherPages(java.lang.String value)

getNumberOfCopies

public int getNumberOfCopies()

Gets or sets a value of number of copies of the current page.

setNumberOfCopies

public void setNumberOfCopies(int value)

getUnlimitedBreakable

public boolean getUnlimitedBreakable()

Gets or sets value indicates that when printing of multiple-sheet cross-reports, columns and strings are to be broken.

setUnlimitedBreakable

public void setUnlimitedBreakable(boolean value)

getLargeHeight

public boolean getLargeHeight()

Gets or sets value indicates that this page has in designer large height.

setLargeHeight

public void setLargeHeight(boolean value)

getLargeHeightFactor

public int getLargeHeightFactor()

Gets or sets large height factor for LargeHeight property of this page.

setLargeHeightFactor

public void setLargeHeightFactor(int value)

getCurrentWidthSegment

public int getCurrentWidthSegment()

Gets or sets the current width of a page segment.

setCurrentWidthSegment

public void setCurrentWidthSegment(int value)

getCurrentHeightSegment

public int getCurrentHeightSegment()

Gets or sets the current height of a page segment.

setCurrentHeightSegment

public void setCurrentHeightSegment(int value)

getStopBeforePrint

public int getStopBeforePrint()

Gets or sets the page number. When it is reached then stop rendering. If the property is 0 then rendering of the report will be stopped.

setStopBeforePrint

public void setStopBeforePrint(int value)

getSkip

public boolean getSkip()

Gets or sets value, indicates that, when rendering of the report, this page of the report is to be skipped. Subreport component is used.

setSkip

public void setSkip(boolean value)

getStretchToPrintArea

public boolean getStretchToPrintArea()

Gets or sets value, indicates that, when printing, a page stretches into print area.

setStretchToPrintArea

public void setStretchToPrintArea(boolean value)

getTitleBeforeHeader

public boolean getTitleBeforeHeader()

Gets or sets value, indicates that it is necessary to put the report title before the page header.

setTitleBeforeHeader

public void setTitleBeforeHeader(boolean titleBeforeHeader)

getUnlimitedHeight

public boolean getUnlimitedHeight()

Gets or sets value, indicates that the page has an unlimited height.

setUnlimitedHeight

public void setUnlimitedHeight(boolean value)

getUnlimitedWidth

public boolean getUnlimitedWidth()

Gets or sets value, indicates that the page has an unlimited width.

setUnlimitedWidth

public void setUnlimitedWidth(boolean value)

getOffsetRectangle

public StiRectangle getOffsetRectangle()

Gets or sets offset of the selected components on the page.

setOffsetRectangle

public void setOffsetRectangle(StiRectangle value)

getOrientation

public StiPageOrientation getOrientation()

Gets or sets page orientation.

setOrientation

public void setOrientation(StiPageOrientation value)

getLocked

public boolean getLocked()

Description copied from class: StiComponent

gets or sets a value which indicates that moving is locked.

Overrides:

getLocked in class StiComponent

setLocked

public void setLocked(boolean value)

Overrides:

setLocked in class StiComponent

getLinked

public boolean getLinked()

Description copied from class: StiComponent

gets or sets a value which indicates whether the object snap to the container is turned on.

Overrides:

getLinked in class StiComponent

setLinked

public void setLinked(boolean value)

Overrides:

setLinked in class StiComponent

getPageWidth

public double getPageWidth()

Gets or sets the total width of the page.

setPageWidth

public void setPageWidth(double value)

getPageHeight

public double getPageHeight()

Gets or sets the total height of the page.

setPageHeight

public void setPageHeight(double value)

getSegmentPerWidth

public int getSegmentPerWidth()

Gets or sets the number of segments per width.

setSegmentPerWidth

public void setSegmentPerWidth(int value)

getSegmentPerHeight

public int getSegmentPerHeight()

Gets or sets the number of segments per height.

setSegmentPerHeight

public void setSegmentPerHeight(int value)

getWatermark

public StiWatermark getWatermark()

Gets or sets watermark of the page.

setWatermark

public void setWatermark(StiWatermark value)

getMargins

public StiMargins getMargins()

Gets or sets page margins.

setMargins

public void setMargins(StiMargins value)

getReport

public StiReport getReport()

Gets or sets the report in which the page is located.

Specified by:

getReport in interface IStiReportProperty

Overrides:

getReport in class StiComponent

setReport

public void setReport(StiReport value)

Overrides:

setReport in class StiComponent

getUnit

public StiUnit getUnit()

getReportUnit

public final StiUnit getReportUnit()

Used for save/load page. Internal use only.

setReportUnit

public final void setReportUnit(StiUnit value)

getLockHighlight

public final boolean getLockHighlight()

setLockHighlight

public final void setLockHighlight(boolean value)

getDrillDownActivated

public final boolean getDrillDownActivated()

setDrillDownActivated

public final void setDrillDownActivated(boolean value)

getCacheGuid

public final java.lang.String getCacheGuid()

Gets or sets a cache guid of page.

NewCacheGuid

public final void NewCacheGuid()

ClearPage

public final void ClearPage()

GetComponentsCount

public int GetComponentsCount()

Overrides:

GetComponentsCount in class StiContainer

getEngineVersion

public StiEngineVersion getEngineVersion()

TitleBeforeHeader

public boolean TitleBeforeHeader()

getComponentPlacementForChildren

public java.lang.String getComponentPlacementForChildren()

Overrides:

getComponentPlacementForChildren in class StiContainer

clone

public java.lang.Object clone()

Description copied from class: StiComponent

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.

getPageInfoV2

public StiPageInfoV2 getPageInfoV2()

getName

public java.lang.String getName()

Description copied from class: StiBase

Gets or sets a component name.

Specified by:

getName in interface IStiName

Overrides:

getName in class StiContainer

getGuid

public java.lang.String getGuid()

Description copied from class: StiComponent

gets or sets a guid of component.

Specified by:

getGuid in interface IStiComponentGuid

Overrides:

getGuid in class StiContainer

getTagValue

public java.lang.Object getTagValue()

Description copied from class: StiComponent

gets or sets tag of a component.

Overrides:

getTagValue in class StiContainer

getLargeHeightAutoFactor

public double getLargeHeightAutoFactor()

large height factor for LargeHeightAuto mode of this page.

Returns:

the largeHeightAutoFactor

setLargeHeightAutoFactor

public void setLargeHeightAutoFactor(double largeHeightAutoFactor)

large height factor for LargeHeightAuto mode of this page.

Parameters:

largeHeightAutoFactor - the largeHeightAutoFactor to set

getMirrorMargins

public java.lang.Boolean getMirrorMargins()

value indicates that mirror margins are set.

Returns:

the mirrorMargins

setMirrorMargins

public void setMirrorMargins(java.lang.Boolean mirrorMargins)

value indicates that mirror margins are set.

Parameters:

mirrorMargins - the mirrorMargins to set

isPage

public boolean isPage()

disposeImagesAndClearComponents

public void disposeImagesAndClearComponents()