Package 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, 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

Modifier and Type	Field	Description
protected static Object	PropertyCanBreak
protected static Object	PropertyProcessingDuplicates

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

bufferedImage, imageBytesToDraw

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
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(String image)

Method Summary

Modifier and Type	Method	Description
boolean	Break(StiComponent dividedComponent, double devideFactor, StiRefObject<Double> divideLine, StiRefObject<Boolean> haveBreaked)	Divides content of components in two parts.
StiRectangle	convertImageMargins(StiRectangle rect, boolean convert)
BufferedImage	getBufferedImage()
BufferedImage	getBufferedImage(StiRectangle rect)
BufferedImage	getBufferedImage(StiRectangle rect, double zoom)
boolean	getCanBreak()	Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
final 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.
final 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.
final String	getGlobalizedName()	Gets or sets special identificator which will be used for report globalization.
StiFontIcons	getIcon()
StiColor	getIconColor()
final String	getImage()
final String	getImageBytes()	Gets or sets the image.
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.
protected String	getImageFromDataColumn()	Returns the image from specified data column.
protected String	getImageFromFile()
protected byte[]	getImageFromResource(StiResourcesCollection resources)
String	GetImageFromSource()	Returns the image being get as a result of rendering.
protected String	getImageFromUrl()
final 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.
final Object	getImageURLValue()	Gets or sets image URL.
String	getLocalizedCategory()	Gets a localized name of the component category.
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	invokeGetImageData(Object sender, StiGetImageDataEventArgs e)
void	invokeGetImageURL(Object sender, StiValueEventArgs e)	// * Raises the GetImageURL event.
void	LoadFromJsonObject(JSONObject jObject)
protected void	OnGetImageData(StiGetImageDataEventArgs e)	Raises the GetImageData event.
protected void	OnGetImageURL(StiValueEventArgs e)	Raises the GetImageURL event.
void	putImage(byte[] image)
void	putImage(String image)
void	resetImage()
BufferedImage	rotateImage(BufferedImage image)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setCanBreak(boolean value)
final void	setDataColumn(String value)
final void	setFile(String value)
void	setGetImageDataEvent(StiGetImageDataEvent value)
void	setGetImageURLEvent(StiGetImageURLEvent value)
final void	setGlobalizedName(String value)
void	setIcon(StiFontIcons icon)
void	setIconColor(StiColor iconColor)
void	setImage(StiImage image)
final void	setImage(String value)
final void	setImageBytes(String value)
void	setImageData(StiImageDataExpression value)
final void	setImageRotation(StiImageRotation value)
void	setImageURL(StiImageURLExpression value)
final void	setImageURLValue(Object value)
void	setProcessingDuplicates(StiImageProcessingDuplicatesType value)

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

clearBufferedImage, clone, existImageToDraw, getActualSize, getAspectRatio, getBorder, getBrush, getHorAlignment, getImageToDraw, getIsCachedImage, getMargins, getMultipleFactor, getObjectToDraw, getRealSize, getSmoothing, getStretch, getVertAlignment, imageToDrawIsMetafile, isEmptyBufferedImage, 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, AllowPrintOn, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearAllStates, ClearContents, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, doPointer, fillComponentPlacement, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getBuilder, getCanGrow, getCanShrink, getClickEvent, getClientRectangle, getComponentPlacement, getComponentStyle, 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, getStates, getTag, getTagStrValue, getTagValue, getToolTip, getToolTipValue, getTop, getUseParentStyles, getWidth, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, invokeBlockly, InvokeClick, InvokeDoubleClick, InvokeEndRender, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, invokeScript, invokeScript, invokeScript, isAutomaticDock, isDesigning, IsParentSelect, NewGuid, OnAfterPrint, OnBeforePrint, OnClick, OnDoubleClick, OngetBookmark, OngetDrillDownReport, OngetHyperlink, OngetTag, OngetToolTip, OnMouseEnter, OnMouseLeave, OnPainted, OnPainting, OnRemoveComponent, packService, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getImage

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

getImage

Field Details

PropertyCanBreak

protected static Object PropertyCanBreak

PropertyProcessingDuplicates

protected static Object PropertyProcessingDuplicates

Constructor Details

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(String image)

StiImage

public StiImage(byte[] bytes)

Method Details

getBufferedImage

public BufferedImage getBufferedImage()

getBufferedImage

public BufferedImage getBufferedImage(StiRectangle rect)

Overrides:

getBufferedImage in class StiView

getBufferedImage

public BufferedImage getBufferedImage(StiRectangle rect,
 double zoom)

Overrides:

getBufferedImage in class StiView

rotateImage

public BufferedImage rotateImage(BufferedImage image)

convertImageMargins

public StiRectangle convertImageMargins(StiRectangle rect,
 boolean convert)

getGlobalizedName

public final 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(String value)

Specified by:

setGlobalizedName in interface IStiGlobalizedName

getImageFromUrl

protected String getImageFromUrl()
                          throws UnsupportedEncodingException,
FileNotFoundException,
IOException

Throws:

UnsupportedEncodingException

FileNotFoundException

IOException

getImageFromResource

protected byte[] getImageFromResource(StiResourcesCollection resources)

Specified by:

getImageFromResource in class StiView

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 String getLocalizedCategory()

Gets a localized name of the component category.

Overrides:

getLocalizedCategory in class StiBase

getLocalizedName

public 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 Object getImageURLValue()

Gets or sets image URL.

setImageURLValue

public final void setImageURLValue(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

invokeGetImageData

public void invokeGetImageData(Object sender,
 StiGetImageDataEventArgs e)

OnGetImageURL

protected void OnGetImageURL(StiValueEventArgs e)

Raises the GetImageURL event.

invokeGetImageURL

public void invokeGetImageURL(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)

OnGetImageData

protected void OnGetImageData(StiGetImageDataEventArgs e)

Raises the GetImageData event.

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 String getImage()

setImage

public final void setImage(String value)

getImageBytes

public final String getImageBytes()

Gets or sets the image.

setImageBytes

public final void setImageBytes(String value)

putImage

public void putImage(byte[] image)
              throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

putImage

public void putImage(String image)

resetImage

public void resetImage()

getFile

public final String getFile()

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

getImageBytesToDraw

public 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(String value)

getImageFromFile

protected String getImageFromFile()

getDataColumn

public final String getDataColumn()

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

setDataColumn

public final void setDataColumn(String value)

Break

public boolean Break(StiComponent dividedComponent,
 double devideFactor,
 StiRefObject<Double> divideLine,
 StiRefObject<Boolean> haveBreaked)

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 String GetImageFromSource()

Returns the image being get as a result of rendering.

Specified by:

GetImageFromSource in class StiView

getImageFromDataColumn

protected String getImageFromDataColumn()

Returns the image from specified data column.

setImage

public void setImage(StiImage image)

getIcon

public StiFontIcons getIcon()

Returns:

the icon

setIcon

public void setIcon(StiFontIcons icon)

Parameters:

icon - the icon to set

getIconColor

public StiColor getIconColor()

Returns:

the iconColor

setIconColor

public void setIconColor(StiColor iconColor)

Parameters:

iconColor - the iconColor to set

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