com.stimulsoft.report.components

Class StiWatermark

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.report.components.StiWatermark

All Implemented Interfaces:

IStiJsonReportObject, IStiSerializable, IStiSerializableRef, java.lang.Cloneable

public class StiWatermark
extends StiSerializedObject
implements java.lang.Cloneable, IStiJsonReportObject

The class describes the watermark of the page.

Field Summary

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

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor and Description
StiWatermark()
StiWatermark(StiBrush textBrush, java.lang.String text, double angle, StiFont font, boolean showBehind)
StiWatermark(StiBrush textBrush, java.lang.String text, double angle, StiFont font, boolean showBehind, boolean enabled, boolean aspectRatio)
StiWatermark(StiBrush textBrush, java.lang.String text, double angle, StiFont font, boolean showBehind, boolean enabled, boolean aspectRatio, boolean rightToLeft)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone()
double	getAngle() Gets or sets angle of Watermark.
boolean	getAspectRatio() Gets or sets value, indicates that this watermark's image will save its aspect ratio.
java.awt.image.BufferedImage	getBufferedImage(StiReport report, StiRectangle rect)
java.lang.String	getBytes()
boolean	getEnabled() Gets or sets value which indicates where Watermark should be drawing or not.
java.lang.String	getEnabledExpression()
StiFont	getFont() Gets or sets font of Watermark.
StiContentAlignment	getImageAlignment() Gets or sets the watermark's image alignment.
java.lang.String	getImageBytes() Gets or sets value watermark's image.
java.lang.String	getImageHyperlink()
double	getImageMultipleFactor() Gets or sets value to multiply by it an image size.
boolean	getImageStretch() Gets or sets value, indicates that this watermark's image will stretch on the page.
boolean	getImageTiling() Gets or sets the watermark's image should be tiled.
int	getImageTransparency() Gets or sets the transparency of the watermark's image.
boolean	getRightToLeft() Gets or sets watermark's output direction.
boolean	getShowBehind() Gets or sets value which indicates where Watermark should be drawing behind or in front of page.
boolean	getShowImageBehind() Gets or sets value which indicates where Watermark's image should be drawing behind or in front of page.
java.lang.String	getText() Gets or sets text of Watermark.
StiBrush	getTextBrush() Gets or sets a brush to Watermark.
void	LoadFromJsonObject(JSONObject jObject)
void	putImage(byte[] image)
void	putImage(java.lang.String image)
void	resetImage()
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setAngle(double value)
void	setAspectRatio(boolean value)
void	setBytes(java.lang.String value)
void	setEnabled(boolean value)
void	setEnabledExpression(java.lang.String enabledExpression)
void	setFont(StiFont value)
void	setImage(java.lang.String value)
void	setImageAlignment(StiContentAlignment value)
void	setImageBytes(java.lang.String value)
void	setImageHyperlink(java.lang.String imageHyperlink)
void	setImageMultipleFactor(double value)
void	setImageStretch(boolean value)
void	setImageTiling(boolean value)
void	setImageTransparency(int imageTransparency)
void	setRightToLeft(boolean value)
void	setShowBehind(boolean value)
void	setShowImageBehind(boolean value)
void	setText(java.lang.String value)
void	setTextBrush(StiBrush value)
boolean	ShouldSerializeTextBrush()

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, toString, wait, wait, wait

Constructor Detail

StiWatermark

public StiWatermark()

StiWatermark

public StiWatermark(StiBrush textBrush,
            java.lang.String text,
            double angle,
            StiFont font,
            boolean showBehind)

StiWatermark

public StiWatermark(StiBrush textBrush,
            java.lang.String text,
            double angle,
            StiFont font,
            boolean showBehind,
            boolean enabled,
            boolean aspectRatio)

StiWatermark

public StiWatermark(StiBrush textBrush,
            java.lang.String text,
            double angle,
            StiFont font,
            boolean showBehind,
            boolean enabled,
            boolean aspectRatio,
            boolean rightToLeft)

Method Detail

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Throws:

JSONException

getBufferedImage

public java.awt.image.BufferedImage getBufferedImage(StiReport report,
                                            StiRectangle rect)

getImageBytes

public java.lang.String getImageBytes()

Gets or sets value watermark's image.

setImageBytes

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

getBytes

public java.lang.String getBytes()

setBytes

public void setBytes(java.lang.String value)

setImage

public void setImage(java.lang.String value)

getImageAlignment

public StiContentAlignment getImageAlignment()

Gets or sets the watermark's image alignment.

setImageAlignment

public void setImageAlignment(StiContentAlignment value)

getAngle

public double getAngle()

Gets or sets angle of Watermark.

getAspectRatio

public final boolean getAspectRatio()

Gets or sets value, indicates that this watermark's image will save its aspect ratio.

getEnabled

public boolean getEnabled()

Gets or sets value which indicates where Watermark should be drawing or not.

getFont

public final StiFont getFont()

Gets or sets font of Watermark.

getImageMultipleFactor

public double getImageMultipleFactor()

Gets or sets value to multiply by it an image size.

getImageStretch

public boolean getImageStretch()

Gets or sets value, indicates that this watermark's image will stretch on the page.

getImageTiling

public boolean getImageTiling()

Gets or sets the watermark's image should be tiled.

getImageTransparency

public int getImageTransparency()

Gets or sets the transparency of the watermark's image.

setImageTransparency

public void setImageTransparency(int imageTransparency)

getRightToLeft

public final boolean getRightToLeft()

Gets or sets watermark's output direction.

getShowBehind

public boolean getShowBehind()

Gets or sets value which indicates where Watermark should be drawing behind or in front of page.

getShowImageBehind

public boolean getShowImageBehind()

Gets or sets value which indicates where Watermark's image should be drawing behind or in front of page.

getText

public java.lang.String getText()

Gets or sets text of Watermark.

getTextBrush

public final StiBrush getTextBrush()

Gets or sets a brush to Watermark.

setAngle

public void setAngle(double value)

setAspectRatio

public final void setAspectRatio(boolean value)

setEnabled

public void setEnabled(boolean value)

setFont

public final void setFont(StiFont value)

setImageMultipleFactor

public void setImageMultipleFactor(double value)

setImageStretch

public void setImageStretch(boolean value)

setImageTiling

public void setImageTiling(boolean value)

setRightToLeft

public final void setRightToLeft(boolean value)

setShowBehind

public void setShowBehind(boolean value)

setShowImageBehind

public void setShowImageBehind(boolean value)

setText

public void setText(java.lang.String value)

setTextBrush

public final void setTextBrush(StiBrush value)

ShouldSerializeTextBrush

public final boolean ShouldSerializeTextBrush()

clone

public final java.lang.Object clone()

Overrides:

clone in class java.lang.Object

getEnabledExpression

public java.lang.String getEnabledExpression()

Returns:

the enabledExpression

setEnabledExpression

public void setEnabledExpression(java.lang.String enabledExpression)

Parameters:

enabledExpression - the enabledExpression to set

getImageHyperlink

public java.lang.String getImageHyperlink()

Returns:

the imageHyperlink

setImageHyperlink

public void setImageHyperlink(java.lang.String imageHyperlink)

Parameters:

imageHyperlink - the imageHyperlink to set