com.stimulsoft.report.components
Class StiComponent

java.lang.Object
  extended by com.stimulsoft.base.serializing.StiSerializedObject
      extended by com.stimulsoft.base.services.StiService
          extended by com.stimulsoft.report.StiBase
              extended by com.stimulsoft.report.components.StiComponent
All Implemented Interfaces:
IStiAppExpressionCollection, IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiName, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiGrowToHeight, IStiInteraction, IStiPrintOn, IStiSelect, IStiShift, IStiUnitConvert, IStiReportProperty, IStiInherited, IStiStateSaveRestore, java.lang.Cloneable
Direct Known Subclasses:
StiBarCode, StiChart, StiCheckBox, StiContainer, StiGauge, StiMap, StiPrimitive, StiShape, StiSimpleText, StiSparkline, StiView, StiWinControl, StiZipCode

public abstract class StiComponent
extends StiBase
implements IStiComponentGuid, IStiCanGrow, IStiCanShrink, IStiUnitConvert, IStiShift, IStiGrowToHeight, IStiConditions, IStiPrintOn, IStiInherited, IStiReportProperty, IStiInteraction, IStiStateSaveRestore, IStiSelect, IStiJsonReportObject, IStiAppExpressionCollection

Describes the base class for all components.


Field Summary
 boolean canGrow
           
 boolean canShrink
           
 java.lang.String componentPlacement
           
 StiConditionsCollection conditions
           
 StiBookmark currentPointer
           
 StiAppExpressionCollection expressions
           
 StiInteraction interaction
           
 boolean isRendered
           
 StiPage page
           
 StiContainer parent
           
 StiBookmark parentBookmark
           
 StiBookmark parentPointer
           
 double top
           
 double width
           
 
Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef
REFERENCE_EMPTY, REFERENCE_REPORT
 
Constructor Summary
StiComponent()
          Creates a new component of the StiComponent type.
StiComponent(StiRectangle rect)
          Creates a new component of the type StiComponent with the specified location.
 
Method Summary
 void addSize(boolean leftToRightDirection)
          Increases the amount of pages on width and on height.
 void applyConditions(java.lang.Object sender, java.util.ArrayList<java.util.Hashtable<StiCondition,java.lang.String>> conditions)
           
 boolean canContainIn(StiComponent component)
          Specifies that this component may be * he specified component.
 boolean CheckForParentComponent(StiComponent comp)
           
 void clearAllStates()
          Clear all states.
 void ClearAllStates()
          Clear all earlier saved object states.
 void ClearContents()
          Clears a text of all selected components.
 java.lang.Object clone()
          Creates a new object that is a copy of the current instance.
 java.lang.Object clone(boolean clonegetProperties)
          Creates a new object that is a copy of the current instanc.
 double ComponentToPage(double value)
          Converts a value from the parent-container coordinates into coordinates of a page.
 StiPoint ComponentToPage(StiPoint point)
          Converts a point from the parent-container coordinates into coordinates of a page.
 StiRectangle ComponentToPage(StiRectangle rect)
          Converts a rectangle from the parent-container coordinates into coordinates of a page.
 void convert(StiUnit oldUnit, StiUnit newUnit)
          Convertes component from one unit into another.
 void convert(StiUnit oldUnit, StiUnit newUnit, boolean isReportSnapshot, boolean convertComponents)
           
 void decrementTop(double value)
           
 void doBookmark()
          Invokes the getBookmark event.
 void DoBookmark()
          Invokes the GetBookmark event.
 void DockToContainer()
          Docks the component and all of its subordinate components.
 StiRectangle DockToContainer(StiRectangle rect)
          Docks a rectangle, relatively to the component, into the rec.
 void doGetBookmark()
          Raises the GetBookmark event.
static StiRectangle DoOffsetRect(StiComponent component, StiRectangle rect, StiRectangle offsetRect)
          tangle to the specified offset.
 void doPointer()
           
 void fillComponentPlacement()
           
 StiSize getActualSize()
          Initializes a new instance of the StiSize class from the specified dimensi.
 StiAfterPrintEvent getAfterPrintEvent()
          Occurs after the component printing.
 java.lang.String getAlias()
          gets or sets a text that will be shown instead of a component name.
 boolean getAllowDelete()
          gets a value which indicates whether deleting of the components is allowed.
 StiEnumSet<StiAnchorMode> getAnchor()
           
 StiBeforePrintEvent getBeforePrintEvent()
          Occurs before printing of the component.
 StiBookmarkExpression getBookmark()
          gets or sets the expression to fill a component bookmark.
 java.lang.String getBookmarkValue()
          gets or sets the component bookmark.
 double getBottom()
          gets bottom position of a component.
 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.
 StiClickEvent getClickEvent()
          Occurs when user clicks on the component in the window of viewer.
 StiRectangle getClientRectangle()
          gets or sets the client area of a component.
 java.lang.String getComponentPlacement()
          gets or sets a value which indicates placement of a simple component.
 java.lang.String getComponentStyle()
          gets or sets a style of a component.
 StiComponentType getComponentType()
          gets the type of processing when printing.
 StiConditionsCollection getConditions()
          gets or sets the collection of conditions.
 StiContainer getContainer()
          Returns the topmost Container(StiPanel or StiPage) in which the component is l * ns null, if nothing is located.
 StiBookmark getCurrentBookmark()
          gets or sets current bookmark for this component.
 StiDataBand getDataBand()
          Returns the DataBand in which the component * Returns null, if nothing is located.
 StiComponent GetDataBand()
           
 StiRectangle getDefaultClientRectangle()
          gets the default client area of a component.
 boolean getDelimiterComponent()
          gets or sets a value indicates that this component is used as the delimiter.
 StiRectangle getDisplayRectangle()
          gets or sets a rectangle of the component which it fills.
 StiRectangle getDisplayRectangle1()
          rectangle of the component showing.
 boolean getDockable()
          gets or sets a value which indicates whether the component will be docked or not.
 StiRectangle getDockRegion(StiComponent parent)
          Retuns an empty rectangle to which docking is poss *
 StiRectangle getDockRegion(StiComponent parent, boolean useColumns)
          Retuns an empty rectangle to which docking is pos *
 StiDockStyle getDockStyle()
          gets or sets a type of the component docking.
 StiDoubleClickEvent getDoubleClickEvent()
          Occurs when user double clicks on the component in the window of viewer.
 java.util.HashMap<java.lang.String,java.lang.Object> getDrillDownParameters()
           
 boolean getEnabled()
          gets or sets a value which indicates will this component be available or not.
 StiEventsCollection getEvents()
          Return events collection of this component.
 StiAppExpressionCollection getExpressions()
           
 boolean getForceRedrawAll()
          gets a value which indicates whether it is necessary to draw again the whole page when moving the component or changing its sizes in the designer.
 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.
 StiComponent getGroupHeaderBand()
           
 StiComponent GetGroupHeaderBand()
           
 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()
           
 StiHighlightState getHighlightState()
          gets or sets a state of highlight.
 StiHyperlinkExpression getHyperlink()
          gets or sets an expression to fill a component hyperlink.
 java.lang.String getHyperlinkValue()
          gets or sets hyperlink of a component.
 boolean getIgnoreNamingRule()
          Internal use only.
 java.awt.image.BufferedImage getImage(java.lang.Double zoom)
           
 java.awt.image.BufferedImage getImage(java.lang.Double zoom, StiExportFormat format)
           
 boolean getInherited()
          Occurs when getting a Tag for a component.
 StiInteraction getInteraction()
          gets interaction options of this component.
 boolean getInvalidateOnMouseOver()
          gets a value which indicates whether invalidating of the component occurs when a mouse pointer is above the component.
 boolean getIsCross()
          gets a value indicating that this is the Cross component.
 boolean getIsDesigning()
          gets a value which indicates that the report in which a component is placed is being designed.
 boolean getIsEnabled()
           
 boolean getIsEventEmpty()
          gets a value which indicates that all events are empty.
 boolean getIsExporting()
          gets or sets value, which indicates that the report is exporting.
 boolean getIsgetTagHandlerEmpty()
           
 boolean getIsPrinting()
          gets a value which indicates that the component has already been printed.
 boolean getIsRendered()
          gets or sets a value which indicates whether a component is rendered or not.
 boolean getIsSelected()
          gets or sets value indicates is the component selected or not.
 double getLeft()
          gets or sets left position of a component.
 int getLevel()
          Returns the level of the object nesti * page, 2 - page and etc.
 boolean getLinked()
          gets or sets a value which indicates whether the object snap to the container is turned on.
 boolean getLocked()
          gets or sets a value which indicates that moving is locked.
 StiSize getMaxSize()
          gets or sets maximal size.
 StiGraphics getMeasureGraphics()
           
 StiSize getMinSize()
          gets or sets minimal size.
 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.
 StiPage getPage()
          gets or sets the page on which an object is located.
 StiRectangle getPaintRectangle()
          Makes all necessary coversions for * bject and returns its coordinates.
 StiRectangle getPaintRectangle(boolean convertToHInches, boolean convertByZoom)
          Makes all necessary conversions for t * put and returns its coordinates.
 StiRectangle getPaintRectangle(boolean convertToHInches, boolean convertByZoom, boolean docking)
          Makes all necessary conversions for * tput and returns its coordinates.
 StiContainer getParent()
          gets or sets the container in which an object is located.
 StiBookmark getParentBookmark()
          gets or sets parent bookmark for this component.
 boolean getPlaceOnToolbox()
          gets or sets a value which indicates whether it is necessary to place component in toolbox or not.
 StiPointerExpression getPointer()
           
 java.lang.Object getPointerValue()
           
 boolean getPrintable()
          gets or sets a value which indicates whether a component is printable or not.
 StiPrintOnType getPrintOn()
          gets or sets a value which indicates on what pages component will be printed.
 int getPriority()
          gets a component priority.
 java.lang.String getQuickInfo()
           
 int getRenderedCount()
          gets or sets a value which indicates how many times a component is rendered.
 StiReport getReport()
          gets or sets the report in which the component is located.
 StiEnumSet<StiRestrictions> getRestrictions()
          gets or sets value which indicates the restrictions of a component.
 double getRight()
          gets right position of a component.
 int getSelectionTick()
           
 StiRectangle getSelectRectangle()
          gets or sets a rectangle of a component selection.
 java.lang.String getServiceCategory()
          gets a category of services.
 java.lang.Class getServiceType()
          gets a service type.
 boolean getShift()
          gets or sets a value which indicates that this component can be shifted.
 StiEnumSet<StiShiftMode> getShiftMode()
          gets or sets a value which indicates the shift mode of a component.
 boolean getShowQuickButtons()
          gets or sets a value which indicates whether it is necessary to show quick buttons.
 StiTagExpression getTag()
          gets or sets the expression to fill a component tag.
 java.lang.String getTagStrValue()
           
 java.lang.Object getTagValue()
          gets or sets tag of a component.
 int getToolboxPosition()
           
 StiToolTipExpression getToolTip()
          gets or sets the expression to fill a component tooltip.
 java.lang.String getToolTipValue()
          gets or sets a component tips.
 double getTop()
          gets or sets top position of a component.
 boolean getUseParentStyles()
          gets or sets a value which indicates that this component must use styles from parent component.
 double getWidth()
          gets or sets width of a component.
 void incrementtTop(double value)
           
 StiComponent InternalRender()
           
 void invert()
          Invert selection of component.
 void InvokeAfterPrint(java.lang.Object sender, StiEventHandlerArgs e)
          Raises th * event.
 void InvokeBeforePrint(java.lang.Object sender, StiEventHandlerArgs e)
          Raises the B * ent.
 void InvokeBeginRender()
           
 void InvokeClick(java.lang.Object sender, StiEventHandlerArgs e)
          Raises the Click * is report.
 void InvokeDoubleClick(java.lang.Object sender, StiEventHandlerArgs e)
          Raises the DoubleCli * this report.
 void InvokeEndRender()
           
 void invokeEvents()
          Invokes all events for this components.
 void InvokegetBookmark(java.lang.Object sender, StiValueEventArgs e)
          Raises the get * t.
 void InvokegetDrillDownReport(java.lang.Object sender, StiGetDrillDownReportEventArgs e)
          Raises the getDrillDownReport e * report.
 void InvokegetHyperlink(java.lang.Object sender, StiValueEventArgs e)
          Raises the getHyper *
 void InvokegetTag(java.lang.Object sender, StiValueEventArgs e)
          Raises the *
 void InvokegetToolTip(java.lang.Object sender, StiValueEventArgs e)
          Raises the getToolT *
 void InvokeMouseEnter(java.lang.Object sender, StiEventHandlerArgs e)
          Raises the MouseE * r this report.
 void InvokeMouseLeave(java.lang.Object sender, StiEventHandlerArgs e)
          Raises the Mous * for this report.
 void InvokePainted(StiComponent sender, StiPaintEventArgs e)
          Raises the * for this component.
 void invokePainting(StiComponent sender, StiPaintArgs e)
          Raises the Pai * or this component.
 boolean isAutomaticDock()
          gets a value which indicates that this is an automatic docking.
 boolean isDesigning()
           
 boolean isExportAsImage(StiExportFormat format)
           
static boolean IsParentSelect(StiComponent component)
          Retuns true * parent component is selected.
 void LoadFromJsonObject(JSONObject JSONObject)
           
 void NewGuid()
          Generates new guid for component.
 void OnRemoveComponent()
           
 void packService()
          Packs a service.
 StiPoint PageToComponent(StiPoint point)
          Converts a point from coordinates of a page into the parent-container coordinates.
 StiRectangle PageToComponent(StiRectangle rect)
          Converts a rectangle from coordinates of a page into the parent-container coordinates.
 void paint(StiPaintArgs e)
          Paints a component.
 boolean PlacedOnColumnBand()
          Specifies whether it is * place the component on the ColumnBand.
 void Prepare()
           
 StiComponent render()
           
 void reset()
          Reset selection of component.
 void Reset()
          Reset selection of component.
 void restoreState(java.lang.String stateName)
          Restores the earlier saved object state.
 void RestoreState(java.lang.String stateName)
          Restores the earlier saved object state.
 void saveState(java.lang.String stateName)
          Saves the current state of an object.
 JSONObject SaveToJsonObject(StiJsonSaveMode mode)
           
 void select()
          Select component.
 void setAfterPrintEvent(StiAfterPrintEvent value)
           
 void setAlias(java.lang.String value)
           
 void setAnchor(StiEnumSet<StiAnchorMode> anchor)
           
 void setBeforePrintEvent(StiBeforePrintEvent value)
           
 void setBookmark(StiBookmarkExpression value)
           
 void setBookmarkValue(java.lang.String value)
           
 void setCanGrow(boolean value)
           
 void setCanShrink(boolean value)
           
 void setClickEvent(StiClickEvent value)
           
 void setClientRectangle(StiRectangle value)
           
 void setComponentPlacement(java.lang.String value)
           
 void setComponentStyle(java.lang.String value)
           
 void setConditions(StiConditionsCollection value)
           
 void setCurrentBookmark(StiBookmark value)
           
 void setDelimiterComponent(boolean value)
           
 void setDirectDisplayRectangle(StiRectangle rect)
           
 void setDisplayRectangle(StiRectangle value)
           
 void setDockable(boolean value)
           
 void setDockStyle(StiDockStyle value)
           
 void setDoubleClickEvent(StiDoubleClickEvent value)
           
 void setDrillDownParameters(java.util.HashMap<java.lang.String,java.lang.Object> value)
           
 void setEnabled(boolean value)
           
 void setExpressions(StiAppExpressionCollection expressions)
           
 void setgetBookmarkEvent(StiGetBookmarkEvent value)
           
 void setgetDrillDownReportEvent(StiGetDrillDownReportEvent value)
           
 void setgetHyperlinkEvent(StiGetHyperlinkEvent value)
           
 void setgetTagEvent(StiGetTagEvent value)
           
 void setgetToolTipEvent(StiGetToolTipEvent value)
           
 void setGrowToHeight(boolean value)
           
 void setGuid(java.lang.String value)
           
 void setHeight(double height)
           
 void setHeightProp(double height)
           
 void setHighlightState(StiHighlightState value)
           
 void setHyperlink(StiHyperlinkExpression value)
           
 void setHyperlinkValue(java.lang.String value)
           
 void setIgnoreNamingRule(boolean value)
           
 void setInherited(boolean value)
           
 void setInteraction(StiInteraction value)
           
 void setIsRendered(boolean value)
           
 void setIsSelected(boolean value)
           
 void setLeft(double value)
           
 void setLeftProp(double left)
           
 void setLinked(boolean value)
           
 void setLocked(boolean value)
           
 void setMaxSize(StiSize value)
           
 void setMinSize(StiSize value)
           
 void setMouseEnterEvent(StiMouseEnterEvent value)
           
 void setMouseLeaveEvent(StiMouseLeaveEvent value)
           
 void setName(java.lang.String value)
           
 void setPage(StiPage page)
           
 void setPaintRectangle(StiRectangle rect)
          Internal use only.
 void setParent(StiContainer value)
           
 void setParentBookmark(StiBookmark value)
           
 void setPlaceOnToolbox(boolean value)
           
 void setPointer(StiPointerExpression pointer)
           
 void setPointerValue(java.lang.Object pointerValue)
           
 void setPrintable(boolean value)
           
 void setPrintOn(StiPrintOnType value)
           
 void setRenderedCount(int value)
           
 void setReport(StiReport value)
          Deprecated. 
 void SetReportVariables()
           
 void setRestrictions(StiEnumSet<StiRestrictions> value)
           
 void setSelectionTick(int value)
           
 void setSelectRectangle(StiRectangle value)
          Returns the GroupHeaderBand in which the component is loc * null, if nothing is located.
 void setShift(boolean value)
           
 void setShiftMode(StiEnumSet<StiShiftMode> value)
           
 void setShowQuickButtons(boolean value)
           
 void setStates(StiStatesManager states)
           
 void setTag(StiTagExpression value)
           
 void setTagValue(java.lang.Object value)
           
 void setToolTip(StiToolTipExpression value)
           
 void setToolTipValue(java.lang.String value)
           
 void setTop(double value)
           
 void setTopProp(double top)
           
 void setUseParentStyles(boolean value)
           
 void setWidth(double value)
           
 void setWidthProp(double width)
           
 java.lang.String toString()
          Returns an Alias of th * he Name of the report.
 void UnPrepare()
           
 
Methods inherited from class com.stimulsoft.report.StiBase
getLocalizedCategory, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

canGrow

public boolean canGrow

canShrink

public boolean canShrink

componentPlacement

public java.lang.String componentPlacement

conditions

public StiConditionsCollection conditions

interaction

public StiInteraction interaction

isRendered

public boolean isRendered

page

public StiPage page

parent

public StiContainer parent

parentBookmark

public StiBookmark parentBookmark

width

public double width

top

public double top

expressions

public StiAppExpressionCollection expressions

parentPointer

public StiBookmark parentPointer

currentPointer

public StiBookmark currentPointer
Constructor Detail

StiComponent

public StiComponent()
Creates a new component of the StiComponent type.


StiComponent

public StiComponent(StiRectangle rect)
Creates a new component of the type StiComponent with the specified location.

Parameters:
rect - Rectangle describes size and position of the component.
Method Detail

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException
Specified by:
SaveToJsonObject in interface IStiJsonReportObject
Throws:
JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject JSONObject)
                        throws JSONException
Specified by:
LoadFromJsonObject in interface IStiJsonReportObject
Throws:
JSONException

getAllowDelete

public boolean getAllowDelete()
gets a value which indicates whether deleting of the components is allowed.


DoBookmark

public void DoBookmark()
Invokes the GetBookmark event.


doGetBookmark

public final void doGetBookmark()
Raises the GetBookmark event.


DoOffsetRect

public static StiRectangle DoOffsetRect(StiComponent component,
                                        StiRectangle rect,
                                        StiRectangle offsetRect)
tangle to the specified offset.

Parameters:
component - The component, relativly to which offset will be done.
rect - A rectangle being offset.
offsetRect - Offset rectangle.
Returns:
Offset rectangle.

IsParentSelect

public static boolean IsParentSelect(StiComponent component)
Retuns true * parent component is selected.

Parameters:
component - A component for checking.
Returns:
True if the parent component is selected.

getIsSelected

public boolean getIsSelected()
gets or sets value indicates is the component selected or not.

Specified by:
getIsSelected in interface IStiSelect

setIsSelected

public void setIsSelected(boolean value)

NewGuid

public final void NewGuid()
Description copied from interface: IStiComponentGuid
Generates new guid for component.

Specified by:
NewGuid in interface IStiComponentGuid

Reset

public final void Reset()
Reset selection of component.


addSize

public final void addSize(boolean leftToRightDirection)
Increases the amount of pages on width and on height. Herewith on width or height of the page ch * s a parent component.

Parameters:
outContainer - The container relative to which size starts to increase.
leftToRightDirection - A parameter which speifiess a direction of adding size to the component.

applyConditions

public final void applyConditions(java.lang.Object sender,
                                  java.util.ArrayList<java.util.Hashtable<StiCondition,java.lang.String>> conditions)

canContainIn

public boolean canContainIn(StiComponent component)
Specifies that this component may be * he specified component.

Parameters:
component - A component for checking.
Returns:
Returns true if this container may be located in the specified component.

CheckForParentComponent

public final boolean CheckForParentComponent(StiComponent comp)

paint

public void paint(StiPaintArgs e)
Paints a component.

Parameters:
e - Argument for painting.

ClearAllStates

public void ClearAllStates()
Clear all earlier saved object states.


ClearContents

public final void ClearContents()
Clears a text of all selected components.


clone

public java.lang.Object clone()
Creates a new object that is a copy of the current instance.

Overrides:
clone in class StiService
Returns:
A new object that is a copy of this instance.

clone

public java.lang.Object clone(boolean clonegetProperties)
Creates a new object that is a copy of the current instanc.

Returns:
A new object that is a copy of this instance.

ComponentToPage

public final double ComponentToPage(double value)
Converts a value from the parent-container coordinates into coordinates of a page. The method calls the Contai * hod of the parent component.

Parameters:
value - A value for converting.
Returns:
Converted value.

ComponentToPage

public final StiPoint ComponentToPage(StiPoint point)
Converts a point from the parent-container coordinates into coordinates of a page. The method calls the Contain * od of the parent component.

Parameters:
point - Point for converting.
Returns:
Converted point.

ComponentToPage

public final StiRectangle ComponentToPage(StiRectangle rect)
Converts a rectangle from the parent-container coordinates into coordinates of a page. The method calls the Container * of the parent component.

Parameters:
rect - A rectangle for converting.
Returns:
Converted rectangle.

doBookmark

public void doBookmark()
Invokes the getBookmark event.


DockToContainer

public void DockToContainer()
Docks the component and all of its subordinate components.


DockToContainer

public StiRectangle DockToContainer(StiRectangle rect)
Docks a rectangle, relatively to the component, into the rec.

Parameters:
rect - Rectangle for docking.
Returns:
Docked client area of the component.

getActualSize

public StiSize getActualSize()
Initializes a new instance of the StiSize class from the specified dimensi.

Returns:
A class of the StiSize type which represents an actual size of the component.

getAfterPrintEvent

public StiAfterPrintEvent getAfterPrintEvent()
Occurs after the component printing.


getAlias

public java.lang.String getAlias()
gets or sets a text that will be shown instead of a component name. If the text is not indicated then the name is shown.


getBeforePrintEvent

public StiBeforePrintEvent getBeforePrintEvent()
Occurs before printing of the component.


getBookmark

public StiBookmarkExpression getBookmark()
gets or sets the expression to fill a component bookmark.


getBookmarkValue

public final java.lang.String getBookmarkValue()
gets or sets the component bookmark.


getBottom

public double getBottom()
gets bottom position of a component.


getCanGrow

public boolean getCanGrow()
gets or sets a value which indicates that this object can grow.

Specified by:
getCanGrow in interface IStiCanGrow

getCanShrink

public boolean getCanShrink()
gets or sets value which indicates that this object can shrink.

Specified by:
getCanShrink in interface IStiCanShrink

getClickEvent

public StiClickEvent getClickEvent()
Occurs when user clicks on the component in the window of viewer.


getClientRectangle

public StiRectangle getClientRectangle()
gets or sets the client area of a component.


getComponentPlacement

public java.lang.String getComponentPlacement()
gets or sets a value which indicates placement of a simple component. Available values: "rt" - StiReportTitleBand "rs" - StiReportSummaryBand "ph" - StiPageHeaderBand "pf" - StiPageFooterBand "h" - StiHeaderBand "h.ap" - StiHeaderBand (OnAllPages) "f" - StiFooterBand "f.ap" - StiFooterBand (OnAllPages) "d" - StiDataBand "gh" - StiGroupHeaderBand "gf" - StiGroupFooterBand "e" - StiEmptyBand "p" - StiPage


fillComponentPlacement

public final void fillComponentPlacement()

getComponentStyle

public java.lang.String getComponentStyle()
gets or sets a style of a component.


getComponentType

public StiComponentType getComponentType()
gets the type of processing when printing.


getConditions

public StiConditionsCollection getConditions()
gets or sets the collection of conditions.

Specified by:
getConditions in interface IStiConditions

getContainer

public StiContainer getContainer()
Returns the topmost Container(StiPanel or StiPage) in which the component is l * ns null, if nothing is located.

Returns:
A container or null if nothing is located.

getCurrentBookmark

public final StiBookmark getCurrentBookmark()
gets or sets current bookmark for this component.


getDataBand

public StiDataBand getDataBand()
Returns the DataBand in which the component * Returns null, if nothing is located.

Returns:
A DataBand in which the component is located.

getDefaultClientRectangle

public StiRectangle getDefaultClientRectangle()
gets the default client area of a component.


getDelimiterComponent

public final boolean getDelimiterComponent()
gets or sets a value indicates that this component is used as the delimiter.


getDisplayRectangle1

public StiRectangle getDisplayRectangle1()
rectangle of the component showing.

Returns:
A rectangle.

getDisplayRectangle

public StiRectangle getDisplayRectangle()
gets or sets a rectangle of the component which it fills. Docking occurs in accordance to the area of a component (Cross - components are docked by ClientRectangle).


getDockable

public boolean getDockable()
gets or sets a value which indicates whether the component will be docked or not.


getDockRegion

public StiRectangle getDockRegion(StiComponent parent)
Retuns an empty rectangle to which docking is poss *

Parameters:
parent - Container being measured.
Returns:
An empty rectangle to which docking is possible.

getDockRegion

public StiRectangle getDockRegion(StiComponent parent,
                                  boolean useColumns)
Retuns an empty rectangle to which docking is pos *

Parameters:
parent - Container being measured.
Returns:
An empty rectangle to which docking is possible.

getDockStyle

public StiDockStyle getDockStyle()
gets or sets a type of the component docking.


getDoubleClickEvent

public StiDoubleClickEvent getDoubleClickEvent()
Occurs when user double clicks on the component in the window of viewer.


getDrillDownParameters

public final java.util.HashMap<java.lang.String,java.lang.Object> getDrillDownParameters()

getEnabled

public boolean getEnabled()
gets or sets a value which indicates will this component be available or not.


getEvents

public StiEventsCollection getEvents()
Return events collection of this component.


getForceRedrawAll

public boolean getForceRedrawAll()
gets a value which indicates whether it is necessary to draw again the whole page when moving the component or changing its sizes in the designer.


getgetBookmarkEvent

public StiGetBookmarkEvent getgetBookmarkEvent()
Occurs when getting of the Bookmark for the component.


getgetDrillDownReportEvent

public StiGetDrillDownReportEvent getgetDrillDownReportEvent()
Occurs when it is required to get a report for the Drill-Down operation.


getgetHyperlinkEvent

public StiGetHyperlinkEvent getgetHyperlinkEvent()
Occurs when getting Hyperlink for the component.


getgetTagEvent

public StiGetTagEvent getgetTagEvent()
Occurs when getting a Tag for a component.


getgetToolTipEvent

public StiGetToolTipEvent getgetToolTipEvent()
Occurs when getting the ToolTip for the component.


getGrowToHeight

public boolean getGrowToHeight()
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

getGuid

public java.lang.String getGuid()
gets or sets a guid of component.

Specified by:
getGuid in interface IStiComponentGuid

getHighlightState

public final StiHighlightState getHighlightState()
gets or sets a state of highlight.


getHyperlink

public StiHyperlinkExpression getHyperlink()
gets or sets an expression to fill a component hyperlink.


getHyperlinkValue

public final java.lang.String getHyperlinkValue()
gets or sets hyperlink of a component.


getIsgetTagHandlerEmpty

public final boolean getIsgetTagHandlerEmpty()

getIgnoreNamingRule

public final boolean getIgnoreNamingRule()
Internal use only.


getInherited

public final boolean getInherited()
Occurs when getting a Tag for a component.

Specified by:
getInherited in interface IStiInherited

getInteraction

public StiInteraction getInteraction()
gets interaction options of this component.

Specified by:
getInteraction in interface IStiInteraction

getInvalidateOnMouseOver

public boolean getInvalidateOnMouseOver()
gets a value which indicates whether invalidating of the component occurs when a mouse pointer is above the component.


getIsDesigning

public final boolean getIsDesigning()
gets a value which indicates that the report in which a component is placed is being designed.


isDesigning

public boolean isDesigning()

getIsEnabled

public final boolean getIsEnabled()

getIsEventEmpty

public final boolean getIsEventEmpty()
gets a value which indicates that all events are empty.


getIsExporting

public final boolean getIsExporting()
gets or sets value, which indicates that the report is exporting.


getIsPrinting

public final boolean getIsPrinting()
gets a value which indicates that the component has already been printed.


getIsRendered

public boolean getIsRendered()
gets or sets a value which indicates whether a component is rendered or not.


getLeft

public double getLeft()
gets or sets left position of a component.


getLevel

public final int getLevel()
Returns the level of the object nesti * page, 2 - page and etc.

Returns:
Level 1 - page, 2 - page and etc.

getLinked

public boolean getLinked()
gets or sets a value which indicates whether the object snap to the container is turned on.


getLocked

public boolean getLocked()
gets or sets a value which indicates that moving is locked.


getMaxSize

public StiSize getMaxSize()
gets or sets maximal size.


getMeasureGraphics

public final StiGraphics getMeasureGraphics()

getMinSize

public StiSize getMinSize()
gets or sets minimal size.


getMouseEnterEvent

public StiMouseEnterEvent getMouseEnterEvent()
Occurs when user enters the mouse into the area of the component in the window of viewer.


getMouseLeaveEvent

public StiMouseLeaveEvent getMouseLeaveEvent()
Occurs when user leaves the mouse out of the area of the component in the window of viewer.


getPage

public StiPage getPage()
gets or sets the page on which an object is located.


getPaintRectangle

public StiRectangle getPaintRectangle()
Makes all necessary coversions for * bject and returns its coordinates.

Returns:
Prepared object.

getPaintRectangle

public final StiRectangle getPaintRectangle(boolean convertToHInches,
                                            boolean convertByZoom)
Makes all necessary conversions for t * put and returns its coordinates.

Parameters:
convertToHInches - Convert into hundredths of inch.
convertByZoom - Convert by zoom.
Returns:
A rectangle of a component.

getPaintRectangle

public final StiRectangle getPaintRectangle(boolean convertToHInches,
                                            boolean convertByZoom,
                                            boolean docking)
Makes all necessary conversions for * tput and returns its coordinates.

Parameters:
convertToHInches - Convert into hundredths of inch.
convertByZoom - Convert by zoom.
docking - A parameter which specifies a docking of the rectangle to the container.
Returns:
A rectangle of a component.

getParent

public StiContainer getParent()
gets or sets the container in which an object is located.


getParentBookmark

public final StiBookmark getParentBookmark()
gets or sets parent bookmark for this component.


getPlaceOnToolbox

public boolean getPlaceOnToolbox()
gets or sets a value which indicates whether it is necessary to place component in toolbox or not.


getPrintable

public boolean getPrintable()
gets or sets a value which indicates whether a component is printable or not.


getPrintOn

public StiPrintOnType getPrintOn()
gets or sets a value which indicates on what pages component will be printed.

Specified by:
getPrintOn in interface IStiPrintOn

getPriority

public int getPriority()
gets a component priority.


getQuickInfo

public java.lang.String getQuickInfo()

getImage

public java.awt.image.BufferedImage getImage(java.lang.Double zoom)

getImage

public java.awt.image.BufferedImage getImage(java.lang.Double zoom,
                                             StiExportFormat format)

getRenderedCount

public final int getRenderedCount()
gets or sets a value which indicates how many times a component is rendered.


getReport

public StiReport getReport()
gets or sets the report in which the component is located.

Specified by:
getReport in interface IStiReportProperty

getRestrictions

public StiEnumSet<StiRestrictions> getRestrictions()
gets or sets value which indicates the restrictions of a component.


getRight

public double getRight()
gets right position of a component.


getSelectionTick

public int getSelectionTick()
Specified by:
getSelectionTick in interface IStiSelect

getSelectRectangle

public StiRectangle getSelectRectangle()
gets or sets a rectangle of a component selection.


getServiceCategory

public java.lang.String getServiceCategory()
gets a category of services.

Overrides:
getServiceCategory in class StiService

getServiceType

public java.lang.Class getServiceType()
gets a service type.

Specified by:
getServiceType in class StiService

getShift

public boolean getShift()
gets or sets a value which indicates that this component can be shifted.

Specified by:
getShift in interface IStiShift

getShiftMode

public StiEnumSet<StiShiftMode> getShiftMode()
gets or sets a value which indicates the shift mode of a component.

Specified by:
getShiftMode in interface IStiShift

getShowQuickButtons

public final boolean getShowQuickButtons()
gets or sets a value which indicates whether it is necessary to show quick buttons.


getTag

public StiTagExpression getTag()
gets or sets the expression to fill a component tag.


getTagValue

public java.lang.Object getTagValue()
gets or sets tag of a component.


getTagStrValue

public java.lang.String getTagStrValue()

getToolboxPosition

public int getToolboxPosition()

getToolTip

public StiToolTipExpression getToolTip()
gets or sets the expression to fill a component tooltip.


getToolTipValue

public final java.lang.String getToolTipValue()
gets or sets a component tips.


getTop

public double getTop()
gets or sets top position of a component.


incrementtTop

public void incrementtTop(double value)

decrementTop

public void decrementTop(double value)

getUseParentStyles

public boolean getUseParentStyles()
gets or sets a value which indicates that this component must use styles from parent component.


getWidth

public double getWidth()
gets or sets width of a component.


InvokeAfterPrint

public void InvokeAfterPrint(java.lang.Object sender,
                             StiEventHandlerArgs e)
Raises th * event.

Parameters:
sender - A sender which invokes an event.
e - A parameter which contains event data.

InvokeBeforePrint

public void InvokeBeforePrint(java.lang.Object sender,
                              StiEventHandlerArgs e)
Raises the B * ent.

Parameters:
sender - A sender which invokes an event.
e - A parameter which contains event data.

InvokeClick

public void InvokeClick(java.lang.Object sender,
                        StiEventHandlerArgs e)
Raises the Click * is report.

Parameters:
sender - A sender which invokes an event.
e - A parameter which contains event data.

InvokeDoubleClick

public void InvokeDoubleClick(java.lang.Object sender,
                              StiEventHandlerArgs e)
Raises the DoubleCli * this report.

Parameters:
sender - A sender which invokes an event.
e - A parameter which contains event data.

invokeEvents

public void invokeEvents()
Invokes all events for this components.


InvokegetBookmark

public final void InvokegetBookmark(java.lang.Object sender,
                                    StiValueEventArgs e)
Raises the get * t.

Parameters:
sender - A sender which invokes an event.
e - A parameter which contains event data.

InvokegetDrillDownReport

public void InvokegetDrillDownReport(java.lang.Object sender,
                                     StiGetDrillDownReportEventArgs e)
Raises the getDrillDownReport e * report.

Parameters:
sender - A sender which invokes an event.
e - A parameter which contains event data.

InvokegetHyperlink

public final void InvokegetHyperlink(java.lang.Object sender,
                                     StiValueEventArgs e)
Raises the getHyper *

Parameters:
sender - A sender which invokes an event.
e - A parameter which contains event data.

InvokegetTag

public final void InvokegetTag(java.lang.Object sender,
                               StiValueEventArgs e)
Raises the *

Parameters:
sender - A sender which invokes an event.
e - A parameter which contains event data.

InvokegetToolTip

public final void InvokegetToolTip(java.lang.Object sender,
                                   StiValueEventArgs e)
Raises the getToolT *

Parameters:
sender - A sender which invokes an event.
e - A parameter which contains event data.

InvokeMouseEnter

public void InvokeMouseEnter(java.lang.Object sender,
                             StiEventHandlerArgs e)
Raises the MouseE * r this report.

Parameters:
sender - A sender which invokes an event.
e - A parameter which contains event data.

InvokeMouseLeave

public void InvokeMouseLeave(java.lang.Object sender,
                             StiEventHandlerArgs e)
Raises the Mous * for this report.

Parameters:
sender - A sender which invokes an event.
e - A parameter which contains event data.

InvokePainted

public final void InvokePainted(StiComponent sender,
                                StiPaintEventArgs e)
Raises the * for this component.

Parameters:
sender - A sender which invokes an event.
e - A parameter which contains event data.

invokePainting

public final void invokePainting(StiComponent sender,
                                 StiPaintArgs e)
Raises the Pai * or this component.

Parameters:
sender - A sender which invokes an event.
e - A parameter which contains event data.

isAutomaticDock

public boolean isAutomaticDock()
gets a value which indicates that this is an automatic docking.


getIsCross

public boolean getIsCross()
gets a value indicating that this is the Cross component.


OnRemoveComponent

public void OnRemoveComponent()

packService

public void packService()
Packs a service.

Overrides:
packService in class StiService

PageToComponent

public final StiPoint PageToComponent(StiPoint point)
Converts a point from coordinates of a page into the parent-container coordinates. The method calls the PageT * thod of the parent component.

Parameters:
point - A point for converting.
Returns:
Converted point.

PageToComponent

public final StiRectangle PageToComponent(StiRectangle rect)
Converts a rectangle from coordinates of a page into the parent-container coordinates. The method calls the PageToCo * d of the parent component.

Parameters:
rect - A rectangle for converting.
Returns:
Converted rectangle.

PlacedOnColumnBand

public final boolean PlacedOnColumnBand()
Specifies whether it is * place the component on the ColumnBand.

Returns:
If the component can be placed on the ColumnBand then returns true.

RestoreState

public void RestoreState(java.lang.String stateName)
Restores the earlier saved object state. *

Parameters:
stateName - A name of the state being restored.

saveState

public void saveState(java.lang.String stateName)
Saves the current state of an object.

Specified by:
saveState in interface IStiStateSaveRestore
Parameters:
stateName - A name of the state being saved.

setAfterPrintEvent

public void setAfterPrintEvent(StiAfterPrintEvent value)

setAlias

public void setAlias(java.lang.String value)

setBeforePrintEvent

public void setBeforePrintEvent(StiBeforePrintEvent value)

setBookmark

public void setBookmark(StiBookmarkExpression value)

setBookmarkValue

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

setCanGrow

public void setCanGrow(boolean value)
Specified by:
setCanGrow in interface IStiCanGrow

setCanShrink

public void setCanShrink(boolean value)
Specified by:
setCanShrink in interface IStiCanShrink

setClickEvent

public void setClickEvent(StiClickEvent value)

setClientRectangle

public void setClientRectangle(StiRectangle value)

setComponentPlacement

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

setComponentStyle

public void setComponentStyle(java.lang.String value)

setConditions

public void setConditions(StiConditionsCollection value)
Specified by:
setConditions in interface IStiConditions

setCurrentBookmark

public final void setCurrentBookmark(StiBookmark value)

setDelimiterComponent

public final void setDelimiterComponent(boolean value)

setDirectDisplayRectangle

public void setDirectDisplayRectangle(StiRectangle rect)

setDisplayRectangle

public void setDisplayRectangle(StiRectangle value)

setDockable

public void setDockable(boolean value)

setDockStyle

public void setDockStyle(StiDockStyle value)

setDoubleClickEvent

public void setDoubleClickEvent(StiDoubleClickEvent value)

setDrillDownParameters

public final void setDrillDownParameters(java.util.HashMap<java.lang.String,java.lang.Object> value)

setEnabled

public void setEnabled(boolean value)

setgetBookmarkEvent

public void setgetBookmarkEvent(StiGetBookmarkEvent value)

setgetDrillDownReportEvent

public void setgetDrillDownReportEvent(StiGetDrillDownReportEvent value)

setgetHyperlinkEvent

public void setgetHyperlinkEvent(StiGetHyperlinkEvent value)

setgetTagEvent

public void setgetTagEvent(StiGetTagEvent value)

setgetToolTipEvent

public void setgetToolTipEvent(StiGetToolTipEvent value)

setGrowToHeight

public void setGrowToHeight(boolean value)
Specified by:
setGrowToHeight in interface IStiGrowToHeight

setGuid

public final void setGuid(java.lang.String value)
Specified by:
setGuid in interface IStiComponentGuid

setHighlightState

public final void setHighlightState(StiHighlightState value)

setHyperlink

public void setHyperlink(StiHyperlinkExpression value)

setHyperlinkValue

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

setIgnoreNamingRule

public final void setIgnoreNamingRule(boolean value)

setInherited

public final void setInherited(boolean value)
Specified by:
setInherited in interface IStiInherited

setInteraction

public void setInteraction(StiInteraction value)
Specified by:
setInteraction in interface IStiInteraction

isExportAsImage

public boolean isExportAsImage(StiExportFormat format)

setIsRendered

public void setIsRendered(boolean value)

setLeftProp

public void setLeftProp(double left)

setLeft

public void setLeft(double value)

setLinked

public void setLinked(boolean value)

setLocked

public void setLocked(boolean value)

setMaxSize

public void setMaxSize(StiSize value)

setMinSize

public void setMinSize(StiSize value)

setMouseEnterEvent

public void setMouseEnterEvent(StiMouseEnterEvent value)

setMouseLeaveEvent

public void setMouseLeaveEvent(StiMouseLeaveEvent value)

setName

public void setName(java.lang.String value)
Specified by:
setName in interface IStiName
Overrides:
setName in class StiBase

setPage

public void setPage(StiPage page)

setPaintRectangle

public final void setPaintRectangle(StiRectangle rect)
Internal use only.


setParent

public void setParent(StiContainer value)

setParentBookmark

public final void setParentBookmark(StiBookmark value)

setPlaceOnToolbox

public void setPlaceOnToolbox(boolean value)

setPrintable

public void setPrintable(boolean value)

setPrintOn

public void setPrintOn(StiPrintOnType value)
Specified by:
setPrintOn in interface IStiPrintOn

setRenderedCount

public final void setRenderedCount(int value)

setReport

@Deprecated
public void setReport(StiReport value)
Deprecated. 


setRestrictions

public void setRestrictions(StiEnumSet<StiRestrictions> value)

setSelectionTick

public void setSelectionTick(int value)

setSelectRectangle

public void setSelectRectangle(StiRectangle value)
Returns the GroupHeaderBand in which the component is loc * null, if nothing is located.


setShift

public void setShift(boolean value)
Specified by:
setShift in interface IStiShift

setShiftMode

public void setShiftMode(StiEnumSet<StiShiftMode> value)
Specified by:
setShiftMode in interface IStiShift

setShowQuickButtons

public final void setShowQuickButtons(boolean value)

setTag

public void setTag(StiTagExpression value)

setTagValue

public final void setTagValue(java.lang.Object value)

setToolTip

public void setToolTip(StiToolTipExpression value)

setToolTipValue

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

setTopProp

public void setTopProp(double top)

setTop

public void setTop(double value)

setUseParentStyles

public void setUseParentStyles(boolean value)

setWidthProp

public void setWidthProp(double width)

setWidth

public void setWidth(double value)

toString

public java.lang.String toString()
Returns an Alias of th * he Name of the report.

Overrides:
toString in class java.lang.Object
Returns:
An Alias of the report or the Name of the report

convert

public void convert(StiUnit oldUnit,
                    StiUnit newUnit,
                    boolean isReportSnapshot,
                    boolean convertComponents)

convert

public void convert(StiUnit oldUnit,
                    StiUnit newUnit)
Description copied from interface: IStiUnitConvert
Convertes component from one unit into another.

Specified by:
convert in interface IStiUnitConvert
Parameters:
oldUnit - Old units.
newUnit - New units.

restoreState

public void restoreState(java.lang.String stateName)
Description copied from interface: IStiStateSaveRestore
Restores the earlier saved object state.

Specified by:
restoreState in interface IStiStateSaveRestore
Parameters:
stateName - A name of the state being restored.

clearAllStates

public void clearAllStates()
Description copied from interface: IStiStateSaveRestore
Clear all states.

Specified by:
clearAllStates in interface IStiStateSaveRestore

select

public void select()
Description copied from interface: IStiSelect
Select component.

Specified by:
select in interface IStiSelect

invert

public void invert()
Description copied from interface: IStiSelect
Invert selection of component.

Specified by:
invert in interface IStiSelect

reset

public void reset()
Description copied from interface: IStiSelect
Reset selection of component.

Specified by:
reset in interface IStiSelect

getGroupHeaderBand

public StiComponent getGroupHeaderBand()

GetGroupHeaderBand

public StiComponent GetGroupHeaderBand()

GetDataBand

public StiComponent GetDataBand()

InvokeBeginRender

public void InvokeBeginRender()

InvokeEndRender

public void InvokeEndRender()

InternalRender

public StiComponent InternalRender()

render

public StiComponent render()

SetReportVariables

public void SetReportVariables()

Prepare

public void Prepare()

UnPrepare

public void UnPrepare()

setHeightProp

public void setHeightProp(double height)

getHeight

public double getHeight()

setHeight

public void setHeight(double height)

setStates

public void setStates(StiStatesManager states)

getAnchor

public StiEnumSet<StiAnchorMode> getAnchor()
Returns:
the anchor

setAnchor

public void setAnchor(StiEnumSet<StiAnchorMode> anchor)
Parameters:
anchor - the anchor to set

getExpressions

public StiAppExpressionCollection getExpressions()
Specified by:
getExpressions in interface IStiAppExpressionCollection
Returns:
the expressions

setExpressions

public void setExpressions(StiAppExpressionCollection expressions)
Specified by:
setExpressions in interface IStiAppExpressionCollection
Parameters:
expressions - the expressions to set

doPointer

public void doPointer()

getPointerValue

public java.lang.Object getPointerValue()
Returns:
the pointerValue

setPointerValue

public void setPointerValue(java.lang.Object pointerValue)
Parameters:
pointerValue - the pointerValue to set

getPointer

public StiPointerExpression getPointer()
Returns:
the pointer

setPointer

public void setPointer(StiPointerExpression pointer)
Parameters:
pointer - the pointer to set