Package com.stimulsoft.report.components.complexcomponents

Class StiSubReport

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

All Implemented Interfaces:

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

public class StiSubReport
extends StiContainer

Field Summary

Fields

Modifier and Type	Field	Description
StiEventHandler	handlerBeforeRenderSubReport
boolean	keepSubReportTogether
String	subReportPageGuid

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

Method Summary

Modifier and Type	Method	Description
boolean	canContainIn(StiComponent component)	May this container be located in the specified component.
void	convert(StiUnit oldUnit, StiUnit newUnit)	Converts a component out of one unit into another.
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.
StiComponentType	getComponentType()	Gets the type of processing when printing.
StiReport	getExternalSubReport()
StiFillParametersEvent	getFillParametersEvent()
boolean	getGrowToHeight()	gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.
boolean	getKeepSubReportTogether()	Gets or sets value which indicates that the SubReport must to be kept together with DataBand on what it is placed.
String	getLocalizedCategory()	Gets a localized name of the component category.
String	getLocalizedName()	Gets a localized component name.
StiParametersCollection	getParameters()	a parameter collection
int	getPriority()	Gets a component priority.
StiEnumSet<StiShiftMode>	getShiftMode()	gets or sets a value which indicates the shift mode of a component.
static StiSubReport	GetSubReportForPage(StiPage page)
protected StiReport	getSubReportFromFile(String file)
protected StiReport	getSubReportFromUrl(String url)
final StiPage	getSubReportPage()	Gets or sets a page that contains SubReport.
final String	getSubReportPageGuid()	Gets or sets a guid of page that contains Subreport.
String	getSubReportUrl()
int	getToolboxPosition()	Gets value to sort a position in the toolbox.
final boolean	getUseExternalReport()	Deprecated.
double	getWidth()	gets or sets width of a component.
void	invokeFillParameters(StiComponent sender, StiFillParametersEventArgs e)
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setCanGrow(boolean value)
void	setCanShrink(boolean value)
void	setClientRectangle(StiRectangle value)
void	setFillParametersEvent(StiFillParametersEvent value)
void	setGrowToHeight(boolean value)
void	setKeepSubReportTogether(boolean value)
void	setParameters(StiParametersCollection parameters)	a parameter collection
void	setShiftMode(StiEnumSet<StiShiftMode> value)
final void	setSubReportPage(StiPage value)
final void	setSubReportPageGuid(String value)
void	setSubReportUrl(String subReportUrl)
final void	setUseExternalReport(boolean value)	Deprecated.
void	setWidth(double value)

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

AlignTo, AlignToGrid, AlignToGrid, Break, BringToFront, ChangePosition, checkBlockedException, CheckBlockedException, checkLargeHeight, ClearAllStates, clone, clone, ContainerToPage, ContainerToPage, 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, getDefaultClientRectangle, 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, getClickEvent, getComponentPlacement, GetComponentStyle, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDockStyle, 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, getLeft, getLevel, getLinked, getLocked, getMaxSize, getMeasureGraphics, getMinSize, getMouseEnterEvent, getMouseLeaveEvent, getPage, getPaintRectangle, getPaintRectangle, getPaintRectangle, getParent, getParentBookmark, getPlaceOnToolbox, getPointer, getPointerValue, getPrintable, getPrintOn, getQuickInfo, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getSelectRectangle, getServiceCategory, getServiceType, getShift, getShowQuickButtons, getStates, getTag, getTagStrValue, getToolTip, getToolTipValue, getTop, getUseParentStyles, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, invokeBlockly, InvokeClick, InvokeDoubleClick, InvokeEndRender, invokeEvents, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, invokeScript, invokeScript, invokeScript, isAutomaticDock, 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, setClickEvent, setComponentPlacement, setComponentStyle, setConditions, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDockStyle, setDoubleClickEvent, setDrillDownParameters, setEnabled, setExpressions, setGetBookmarkEvent, setGetDrillDownReportEvent, setGetHyperlinkEvent, setGetTagEvent, setGetToolTipEvent, setGuid, setHeight, setHeightProp, setHighlightState, setHyperlink, setHyperlinkValue, setIgnoreNamingRule, setInherited, setInteraction, setIsRendered, setIsSelected, setLeft, setLeftProp, setLinked, setLocked, setMaxSize, setMinSize, setMouseEnterEvent, setMouseLeaveEvent, setName, setPage, setPaintRectangle, setParent, setParentBookmark, setPlaceOnToolbox, setPointer, setPointerValue, setPrintable, setPrintOn, setRenderedCount, setReport, SetReportVariables, setRestrictions, setSelectionTick, setSelectRectangle, setShift, setShowQuickButtons, setStates, setTag, setTagValue, setToolTip, setToolTipValue, setTop, setTopProp, setUseParentStyles, setWidthProp, toString, UnPrepare

Methods inherited from class com.stimulsoft.report.StiBase

getServiceName

Methods inherited from class com.stimulsoft.base.services.StiService

getProperties, getServiceEnabled, getServiceInfo, isPropertyPresent, MemberwiseClone, properties, setProperties, setServiceEnabled

Methods inherited from class com.stimulsoft.base.serializing.StiSerializedObject

cleanReference, getReference, setReference

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getReference, setReference

Field Details

keepSubReportTogether

public boolean keepSubReportTogether

subReportPageGuid

public String subReportPageGuid

handlerBeforeRenderSubReport

public StiEventHandler handlerBeforeRenderSubReport

Constructor Details

StiSubReport

public StiSubReport()

Creates a new component of the type StiSubReport.

StiSubReport

public StiSubReport(StiRectangle rect)

Creates a new component of the type StiSubReport.

Parameters:

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

Method Details

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

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

getFillParametersEvent

public StiFillParametersEvent getFillParametersEvent()

setFillParametersEvent

public void setFillParametersEvent(StiFillParametersEvent value)

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

getToolboxPosition

public int getToolboxPosition()

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiContainer

canContainIn

public boolean canContainIn(StiComponent component)

May this container be located in the specified component.

Overrides:

canContainIn in class StiComponent

Parameters:

component - Component for checking.

Returns:

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

getComponentType

public StiComponentType getComponentType()

Gets the type of processing when printing.

Overrides:

getComponentType in class StiContainer

getLocalizedCategory

public String getLocalizedCategory()

Gets a localized name of the component category.

Overrides:

getLocalizedCategory in class StiContainer

getLocalizedName

public String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiContainer

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

getPriority

public int getPriority()

Gets a component priority.

Overrides:

getPriority in class StiContainer

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.

getWidth

public double getWidth()

Description copied from class: StiComponent

gets or sets width of a component.

Overrides:

getWidth in class StiComponent

setWidth

public void setWidth(double value)

Overrides:

setWidth in class StiComponent

setClientRectangle

public void setClientRectangle(StiRectangle value)

Overrides:

setClientRectangle in class StiComponent

getUseExternalReport

@Deprecated
public final boolean getUseExternalReport()

Deprecated.

Gets or sets value which indicates that this subreport requires the external report.

setUseExternalReport

@Deprecated
public final void setUseExternalReport(boolean value)

Deprecated.

getKeepSubReportTogether

public boolean getKeepSubReportTogether()

Gets or sets value which indicates that the SubReport must to be kept together with DataBand on what it is placed.

setKeepSubReportTogether

public void setKeepSubReportTogether(boolean value)

GetSubReportForPage

public static StiSubReport GetSubReportForPage(StiPage page)

getSubReportPage

public final StiPage getSubReportPage()

Gets or sets a page that contains SubReport.

setSubReportPage

public final void setSubReportPage(StiPage value)

getSubReportPageGuid

public final String getSubReportPageGuid()

Gets or sets a guid of page that contains Subreport.

setSubReportPageGuid

public final void setSubReportPageGuid(String value)

getSubReportUrl

public String getSubReportUrl()

Returns:

the subReportUrl

setSubReportUrl

public void setSubReportUrl(String subReportUrl)

Parameters:

subReportUrl - the subReportUrl to set

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiContainer

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiContainer

Throws:

JSONException

invokeFillParameters

public void invokeFillParameters(StiComponent sender,
 StiFillParametersEventArgs e)

getParameters

public StiParametersCollection getParameters()

a parameter collection

Returns:

the parameters

setParameters

public void setParameters(StiParametersCollection parameters)

a parameter collection

Parameters:

parameters - the parameters to set

getSubReportFromUrl

protected StiReport getSubReportFromUrl(String url)

getSubReportFromFile

protected StiReport getSubReportFromFile(String file)

getExternalSubReport

public StiReport getExternalSubReport()