Package com.stimulsoft.report.components.complexcomponents

Class StiClone

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

All Implemented Interfaces:

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

public class StiClone
extends StiContainer
implements IStiIgnoryStyle, IStiClone

Describes class that realizes component - Clone.

Field Summary

Fields

Modifier and Type	Field	Description
String	jsonContainerValueTemp

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
StiClone()	Creates a new clone.
StiClone(StiRectangle rect)	Creates a new clone.

Method Summary

Modifier and Type	Method	Description
boolean	canContainIn(StiComponent component)	May this container be located in the specified component.
Object	clone()	Creates a new object that is a copy of the current instance.
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.
StiComponentsCollection	getComponents()	Gets or sets a collection of components.
StiComponentType	getComponentType()	Gets the type of processing when printing.
final StiConditionsCollection	getConditions()	gets or sets the collection of conditions.
final StiContainer	getContainer()	Gets or sets a clone container.
boolean	getForceRedrawAll()	Gets value, indicates that it is necessary to draw again the whole page when moving the component or changing its sizes in the designer.
boolean	getGrowToHeight()	gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.
boolean	getIsRendered()	Gets or sets value indicates whether a component is rendered or not.
String	getJsonContainerValueTemp()
String	getLocalizedCategory()	Gets a localized name of the component category.
String	getLocalizedName()	Gets a localized component name.
final boolean	getScaleHor()	Gets or sets value which indicates that contents of the container will be shrunk or grown.
int	getToolboxPosition()	Gets value to sort a position in the toolbox.
void	LoadFromJsonObject(JSONObject jObject)
protected void	OnAfterPrint(EventArgs e)	Raises the AfterPrint event.
protected void	OnBeforePrint(EventArgs e)	Raises the BeforePrint event.
void	RestoreState(String stateName)	Restores the earlier saved object state.
void	saveState(String stateName)	Saves the current state of an object.
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setCanGrow(boolean value)
void	setCanShrink(boolean value)
final void	setConditions(StiConditionsCollection value)
final void	setContainer(StiContainer value)
void	setGrowToHeight(boolean value)
void	setIsRendered(boolean value)
final void	setScaleHor(boolean 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, Convert, ConvertSelectedToPage, ConvertToPage, Correct, Correct, correct2, getActualSize, getActualSize, getBlocked, getBorder, GetBorder, getBrush, GetBrush, getCanBreak, getClientRectangle, getCollapsedValue, getCollapsingIndex, getCollapsingTreePath, getComponentPlacementForChildren, GetComponents, GetComponentsCount, GetComponentsList, getComponentsSelectedRectangle, getComponentStyle, GetConditions, getContainerInfoV1, getContainerInfoV2, GetContainerInRect, GetContainerInRect2, getDefaultClientRectangle, GetDockableComponent, GetDockStyle, GetFirstSelectableCompanent, GetFont, getGuid, getHasSelected, GetHorAlignment, GetIncorrect, GetIncorrect, getIncorrect2, GetMaxSize, getName, getPriority, 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, 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, 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, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDockStyle, getDoubleClickEvent, getDrillDownParameters, getEnabled, getEvents, getExpressions, getGetBookmarkEvent, getGetDrillDownReportEvent, getGetHyperlinkEvent, getGetTagEvent, getGetToolTipEvent, getGroupHeaderBand, GetGroupHeaderBand, getHeight, getHighlightState, getHyperlink, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInteraction, getInvalidateOnMouseOver, getIsCross, getIsDesigning, getIsEnabled, getIsEventEmpty, getIsExporting, getIsgetTagHandlerEmpty, getIsPrinting, 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, getShiftMode, getShowQuickButtons, getStates, getTag, getTagStrValue, getToolTip, getToolTipValue, getTop, getUseParentStyles, getWidth, 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, 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, setClientRectangle, setComponentPlacement, setComponentStyle, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDockStyle, setDoubleClickEvent, setDrillDownParameters, setEnabled, setExpressions, setGetBookmarkEvent, setGetDrillDownReportEvent, setGetHyperlinkEvent, setGetTagEvent, setGetToolTipEvent, setGuid, setHeight, setHeightProp, setHighlightState, setHyperlink, setHyperlinkValue, setIgnoreNamingRule, setInherited, setInteraction, 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, setShiftMode, setShowQuickButtons, setStates, setTag, setTagValue, setToolTip, setToolTipValue, setTop, setTopProp, setUseParentStyles, setWidth, 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

jsonContainerValueTemp

public String jsonContainerValueTemp

Constructor Details

StiClone

public StiClone()

Creates a new clone.

StiClone

public StiClone(StiRectangle rect)

Creates a new clone.

Parameters:

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

Method Details

saveState

public void saveState(String stateName)

Saves the current state of an object.

Specified by:

saveState in interface IStiStateSaveRestore

Overrides:

saveState in class StiContainer

Parameters:

stateName - A name of the state being saved.

RestoreState

public void RestoreState(String stateName)

Restores the earlier saved object state.

Overrides:

RestoreState in class StiContainer

Parameters:

stateName - A name of the state being restored.

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

getContainer

public final StiContainer getContainer()

Gets or sets a clone container.

Specified by:

getContainer in interface IStiClone

Overrides:

getContainer in class StiComponent

Returns:

A container or null if nothing is located.

setContainer

public final void setContainer(StiContainer value)

Specified by:

setContainer in interface IStiClone

clone

public Object clone()

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.

getIsRendered

public boolean getIsRendered()

Gets or sets value indicates whether a component is rendered or not.

Overrides:

getIsRendered in class StiComponent

setIsRendered

public void setIsRendered(boolean value)

Overrides:

setIsRendered in class StiComponent

getConditions

public final StiConditionsCollection getConditions()

Description copied from class: StiComponent

gets or sets the collection of conditions.

Specified by:

getConditions in interface IStiConditions

Overrides:

getConditions in class StiComponent

setConditions

public final void setConditions(StiConditionsCollection value)

Specified by:

setConditions in interface IStiConditions

Overrides:

setConditions in class StiComponent

getToolboxPosition

public int getToolboxPosition()

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiContainer

getForceRedrawAll

public boolean getForceRedrawAll()

Gets value, indicates that it is necessary to draw again the whole page when moving the component or changing its sizes in the designer.

Overrides:

getForceRedrawAll in class StiComponent

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.

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

getComponentType

public StiComponentType getComponentType()

Gets the type of processing when printing.

Overrides:

getComponentType in class StiContainer

getComponents

public StiComponentsCollection getComponents()

Gets or sets a collection of components.

Overrides:

getComponents in class StiContainer

OnBeforePrint

protected void OnBeforePrint(EventArgs e)

Raises the BeforePrint event.

Overrides:

OnBeforePrint in class StiComponent

Parameters:

e - A parameter which contains event data.

OnAfterPrint

protected void OnAfterPrint(EventArgs e)

Raises the AfterPrint event.

Overrides:

OnAfterPrint in class StiComponent

Parameters:

e - A parameter which contains event data.

getScaleHor

public final boolean getScaleHor()

Gets or sets value which indicates that contents of the container will be shrunk or grown.

setScaleHor

public final void setScaleHor(boolean value)

getJsonContainerValueTemp

public String getJsonContainerValueTemp()

Returns:

the jsonContainerValueTemp

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