Package com.stimulsoft.report.components.simplecomponents

Class StiPrimitive

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.simplecomponents.StiPrimitive

All Implemented Interfaces:

IStiAppExpressionCollection, IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiName, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiGrowToHeight, IStiInteraction, IStiPrintOn, IStiSelect, IStiShift, IStiUnitConvert, IStiReportProperty, IStiInherited, IStiStateSaveRestore, Cloneable

Direct Known Subclasses:

StiLinePrimitive, StiPointPrimitive

public abstract class StiPrimitive
extends StiComponent

Describes class that realizes base component for all primitives.

Field Summary

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

Method Summary

Modifier and Type	Method	Description
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.
StiComponentType	getComponentType()	Gets the type of processing when printing.
final StiConditionsCollection	getConditions()	gets or sets the collection of conditions.
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	getGrowToHeight()	gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.
String	getLocalizedCategory()	Gets a localized name of the component category.
int	getPriority()	Gets a component priority.
boolean	getShift()	gets or sets a value which indicates that this component can be shifted.
boolean	getUseParentStyles()	gets or sets a value which indicates that this component must use styles from parent component.
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setCanGrow(boolean value)
void	setCanShrink(boolean value)
void	setClientRectangle(StiRectangle value)
final void	setConditions(StiConditionsCollection value)
void	setDirectDisplayRectangle(StiRectangle rect)
void	setDisplayRectangle(StiRectangle value)
void	setDockStyle(StiDockStyle value)
void	setGrowToHeight(boolean value)
void	setShift(boolean value)
void	setUseParentStyles(boolean value)

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

addSize, AllowPrintOn, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearAllStates, ClearContents, clone, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, doPointer, fillComponentPlacement, getActualSize, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getBuilder, getClickEvent, getComponentPlacement, getComponentStyle, GetComponentStyle, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDefaultClientRectangle, getDelimiterComponent, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDoubleClickEvent, getDrillDownParameters, getEnabled, getEvents, getExpressions, getForceRedrawAll, getGetBookmarkEvent, getGetDrillDownReportEvent, getGetHyperlinkEvent, getGetTagEvent, getGetToolTipEvent, getGroupHeaderBand, GetGroupHeaderBand, getGuid, 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, getShiftMode, getShowQuickButtons, getStates, getTag, getTagStrValue, getTagValue, getToolboxPosition, getToolTip, getToolTipValue, getTop, 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, LoadFromJsonObject, 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, RestoreState, saveState, select, setAfterPrintEvent, setAlias, setAnchor, setBeforePrintEvent, setBookmark, setBookmarkValue, setClickEvent, setComponentPlacement, setComponentStyle, setCurrentBookmark, setDelimiterComponent, setDockable, 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, setShiftMode, setShowQuickButtons, setStates, setTag, setTagValue, setToolTip, setToolTipValue, setTop, setTopProp, setWidth, setWidthProp, toString, UnPrepare

Methods inherited from class com.stimulsoft.report.StiBase

getLocalizedName, getName, 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

Constructor Details

StiPrimitive

public StiPrimitive()

Creates a new StiPrimitive.

StiPrimitive

public StiPrimitive(StiRectangle rect)

Creates a new StiPrimitive.

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

getShift

public boolean getShift()

Description copied from class: StiComponent

gets or sets a value which indicates that this component can be shifted.

Specified by:

getShift in interface IStiShift

Overrides:

getShift in class StiComponent

setShift

public void setShift(boolean value)

Specified by:

setShift in interface IStiShift

Overrides:

setShift in class StiComponent

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

getDockStyle

public StiDockStyle getDockStyle()

Description copied from class: StiComponent

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

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

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

getLocalizedCategory

public String getLocalizedCategory()

Gets a localized name of the component category.

Overrides:

getLocalizedCategory in class StiBase

getComponentType

public StiComponentType getComponentType()

Gets the type of processing when printing.

Overrides:

getComponentType in class StiComponent

getPriority

public int getPriority()

Gets a component priority.

Overrides:

getPriority in class StiComponent

getClientRectangle

public StiRectangle getClientRectangle()

Gets or sets the client area of a component.

Overrides:

getClientRectangle in class StiComponent

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

setDisplayRectangle

public void setDisplayRectangle(StiRectangle value)

Overrides:

setDisplayRectangle in class StiComponent

setDirectDisplayRectangle

public void setDirectDisplayRectangle(StiRectangle rect)

Overrides:

setDirectDisplayRectangle in class StiComponent

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiComponent

Throws:

JSONException