com.stimulsoft.report.components.simplecomponents
Class StiImage

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.StiView
                      com.stimulsoft.report.components.simplecomponents.StiImage

All Implemented Interfaces:

IStiAppExpressionCollection, IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiName, IStiBorder, IStiBreakable, IStiBrush, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiExportImage, IStiExportImageExtended, IStiGlobalizedName, IStiGrowToHeight, IStiHorAlignment, IStiInteraction, IStiPrintOn, IStiSelect, IStiShift, IStiUnitConvert, IStiVertAlignment, IStiReportProperty, IStiInherited, IStiStateSaveRestore, java.lang.Cloneable

Direct Known Subclasses:

StiTableCellImage

public class StiImage
extends StiView
implements IStiBreakable, IStiGlobalizedName

The class describes the component of printing for image printing - Image.

Field Summary

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

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

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

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

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

StiImage(byte[] bytes)

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

StiImage(java.lang.String image)

Method Summary

boolean	Break(StiComponent dividedComponent, double devideFactor, StiRefObject<java.lang.Double> divideLine) Divides content of components in two parts.
StiRectangle	convertImageMargins(StiRectangle rect, boolean convert)
java.awt.image.BufferedImage	getBufferedImage()
java.awt.image.BufferedImage	getBufferedImage(StiRectangle rect)
boolean	getCanBreak() Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
java.lang.String	getDataColumn() Gets or sets a name of the column that contains the image.
StiRectangle	getDefaultClientRectangle() Gets or sets the default client area of a component.
java.lang.String	getFile() Gets or sets the path to the file that contains the image.
StiGetImageDataEvent	getGetImageDataEvent() Occurs when getting image for the component.
StiGetImageURLEvent	getGetImageURLEvent() Occurs when getting image url for the component.
java.lang.String	getGlobalizedName() Gets or sets special identificator which will be used for report globalization.
java.lang.String	getImage()
java.lang.String	getImageBytes() Gets or sets the image.
java.lang.String	getImageBytesToDraw() Gets or sets the image that appeared as a result of the component rendering.
StiImageDataExpression	getImageData() Gets or sets the expression to fill a component image property.
java.lang.String	GetImageFromSource() Returns the image being get as a result of rendering.
StiImageRotation	getImageRotation() Gets or sets value which indicates how to rotate an image before output.
StiImageURLExpression	getImageURL() Gets or sets the expression to fill a component image URL.
java.lang.Object	getImageURLValue() Gets or sets image URL.
java.lang.String	getLocalizedCategory() Gets a localized name of the component category.
java.lang.String	getLocalizedName() Gets a localized component name.
StiImageProcessingDuplicatesType	getProcessingDuplicates() Gets or sets value which indicates how report engine processes duplicated images.
int	getToolboxPosition() Gets value to sort a position in the toolbox.
void	invokeEvents() Invokes all events for this components.
void	invokeGetImageURL(java.lang.Object sender, StiValueEventArgs e) // * Raises the GetImageURL event.
void	LoadFromJsonObject(JSONObject jObject)
void	putImage(byte[] image)
void	putImage(java.lang.String image)
void	resetImage()
java.awt.image.BufferedImage	rotateImage(java.awt.image.BufferedImage image)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setCanBreak(boolean value)
void	setDataColumn(java.lang.String value)
void	setFile(java.lang.String value)
void	setGetImageDataEvent(StiGetImageDataEvent value)
void	setGetImageURLEvent(StiGetImageURLEvent value)
void	setGlobalizedName(java.lang.String value)
void	setImage(StiImage image)
void	setImage(java.lang.String value)
void	setImageBytes(java.lang.String value)
void	setImageData(StiImageDataExpression value)
void	setImageRotation(StiImageRotation value)
void	setImageURL(StiImageURLExpression value)
void	setImageURLValue(java.lang.Object value)
void	setProcessingDuplicates(StiImageProcessingDuplicatesType value)

Methods inherited from class com.stimulsoft.report.components.simplecomponents.StiView

clone, existImageToDraw, getActualSize, getAspectRatio, getBorder, getBrush, getBufferedImage, getHorAlignment, getImageToDraw, getIsCachedImage, getMargins, getMultipleFactor, getObjectToDraw, getRealSize, getSmoothing, getStretch, getVertAlignment, imageToDrawIsMetafile, isExportAsImage, IsExportAsImage, setAspectRatio, setBorder, setBrush, setHorAlignment, setImageBytesToDraw, setImageToDraw, setIsCachedImage, setMargins, setMultipleFactor, setObjectToDraw, setSmoothing, setStretch, setVertAlignment

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

addSize, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearAllStates, ClearContents, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, fillComponentPlacement, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getCanGrow, getCanShrink, getClickEvent, getClientRectangle, getComponentPlacement, getComponentStyle, getComponentType, 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, getGrowToHeight, 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, getPriority, getQuickInfo, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getSelectRectangle, getServiceCategory, getServiceType, getShift, getShiftMode, getShowQuickButtons, getTag, getTagStrValue, getTagValue, getToolTip, getToolTipValue, getTop, getUseParentStyles, getWidth, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, InvokeClick, InvokeDoubleClick, InvokeEndRender, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, isAutomaticDock, isDesigning, IsParentSelect, NewGuid, OnRemoveComponent, packService, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, RestoreState, saveState, select, setAfterPrintEvent, setAlias, setAnchor, setBeforePrintEvent, setBookmark, setBookmarkValue, setCanGrow, setCanShrink, setClickEvent, setClientRectangle, setComponentPlacement, setComponentStyle, setConditions, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDockStyle, setDoubleClickEvent, setDrillDownParameters, setEnabled, setExpressions, setgetBookmarkEvent, setgetDrillDownReportEvent, setgetHyperlinkEvent, setgetTagEvent, setgetToolTipEvent, setGrowToHeight, 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, setShiftMode, setShowQuickButtons, setStates, setTag, setTagValue, setToolTip, setToolTipValue, setTop, setTopProp, setUseParentStyles, setWidth, setWidthProp, toString, UnPrepare

Methods inherited from class com.stimulsoft.report.StiBase

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

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

getImage

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

getImage

Constructor Detail

StiImage

public StiImage()

Creates a new component of the type StiImage.

StiImage

public StiImage(StiRectangle rect)

Creates a new component of the type StiImage with specified location.

Parameters:

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

StiImage

public StiImage(java.lang.String image)

StiImage

public StiImage(byte[] bytes)

Method Detail

getBufferedImage

public java.awt.image.BufferedImage getBufferedImage()

getBufferedImage

public java.awt.image.BufferedImage getBufferedImage(StiRectangle rect)

Overrides:

getBufferedImage in class StiView

rotateImage

public java.awt.image.BufferedImage rotateImage(java.awt.image.BufferedImage image)

convertImageMargins

public StiRectangle convertImageMargins(StiRectangle rect,
                                        boolean convert)

getGlobalizedName

public final java.lang.String getGlobalizedName()

Gets or sets special identificator which will be used for report globalization.

Specified by:

getGlobalizedName in interface IStiGlobalizedName

setGlobalizedName

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

Specified by:

setGlobalizedName in interface IStiGlobalizedName

getCanBreak

public boolean getCanBreak()

Gets or sets value which indicates whether the component can or cannot break its contents on several pages.

Specified by:

getCanBreak in interface IStiBreakable

setCanBreak

public void setCanBreak(boolean value)

Specified by:

setCanBreak in interface IStiBreakable

getToolboxPosition

public int getToolboxPosition()

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiComponent

getLocalizedCategory

public java.lang.String getLocalizedCategory()

Gets a localized name of the component category.

Overrides:

getLocalizedCategory in class StiBase

getLocalizedName

public java.lang.String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiBase

getDefaultClientRectangle

public StiRectangle getDefaultClientRectangle()

Gets or sets the default client area of a component.

Overrides:

getDefaultClientRectangle in class StiComponent

getImageURLValue

public final java.lang.Object getImageURLValue()

Gets or sets image URL.

setImageURLValue

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

getImageURL

public StiImageURLExpression getImageURL()

Gets or sets the expression to fill a component image URL.

setImageURL

public void setImageURL(StiImageURLExpression value)

getImageData

public StiImageDataExpression getImageData()

Gets or sets the expression to fill a component image property.

setImageData

public void setImageData(StiImageDataExpression value)

invokeEvents

public void invokeEvents()

Description copied from class: StiComponent

Invokes all events for this components.

Overrides:

invokeEvents in class StiComponent

invokeGetImageURL

public void invokeGetImageURL(java.lang.Object sender,
                              StiValueEventArgs e)

// * Raises the GetImageURL event. //

getGetImageURLEvent

public StiGetImageURLEvent getGetImageURLEvent()

Occurs when getting image url for the component.

setGetImageURLEvent

public void setGetImageURLEvent(StiGetImageURLEvent value)

getGetImageDataEvent

public StiGetImageDataEvent getGetImageDataEvent()

Occurs when getting image for the component.

setGetImageDataEvent

public void setGetImageDataEvent(StiGetImageDataEvent value)

getProcessingDuplicates

public StiImageProcessingDuplicatesType getProcessingDuplicates()

Gets or sets value which indicates how report engine processes duplicated images.

setProcessingDuplicates

public void setProcessingDuplicates(StiImageProcessingDuplicatesType value)

getImageRotation

public final StiImageRotation getImageRotation()

Gets or sets value which indicates how to rotate an image before output.

setImageRotation

public final void setImageRotation(StiImageRotation value)

getImage

public final java.lang.String getImage()

setImage

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

getImageBytes

public final java.lang.String getImageBytes()

Gets or sets the image.

setImageBytes

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

putImage

public void putImage(byte[] image)
              throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

putImage

public void putImage(java.lang.String image)

resetImage

public void resetImage()

getFile

public final java.lang.String getFile()

Gets or sets the path to the file that contains the image.

getImageBytesToDraw

public java.lang.String getImageBytesToDraw()

Description copied from class: StiView

Gets or sets the image that appeared as a result of the component rendering.

Overrides:

getImageBytesToDraw in class StiView

setFile

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

getDataColumn

public final java.lang.String getDataColumn()

Gets or sets a name of the column that contains the image.

setDataColumn

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

Break

public boolean Break(StiComponent dividedComponent,
                     double devideFactor,
                     StiRefObject<java.lang.Double> divideLine)

Description copied from interface: IStiBreakable

Divides content of components in two parts. Returns result of dividing. If true, then component is successful divided.

Specified by:

Break in interface IStiBreakable

Parameters:

dividedComponent - Component for store part of content.

Returns:

If true, then component is successful divided.

GetImageFromSource

public java.lang.String GetImageFromSource()

Returns the image being get as a result of rendering.

Specified by:

GetImageFromSource in class StiView

setImage

public void setImage(StiImage image)

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiView

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiView

Throws:

JSONException