Packagestimulsoft.report.components
Classpublic class StiWatermark
InheritanceStiWatermark Inheritance StiObject Inheritance Object
Implements IStiRef, IStiWatermark, IStiSerializable



Public Properties
 PropertyDefined By
  angle : Number
Gets or sets angle of Watermark.
StiWatermark
  aspectRatio : Boolean
Gets or sets value, indicates that this watermark's image will save its aspect ratio.
StiWatermark
  enabled : Boolean
Gets or sets value which indicates where Watermark should be drawing or not.
StiWatermark
  font : StiFont
Gets or sets font of Watermark.
StiWatermark
  image : String
Gets or sets value watermark's image.
StiWatermark
  imageAlignment : int
Gets or sets the watermark's image alignment.
StiWatermark
  imageBitmap : BitmapData
StiWatermark
  imageMultipleFactor : Number
Gets or sets value to multiply by it an image size.
StiWatermark
  imageStretch : Boolean
Gets or sets value, indicates that this watermark's image will stretch on the page.
StiWatermark
  imageTiling : Boolean
Gets or sets the watermark's image should be tiled.
StiWatermark
  imageToDraw : String
StiWatermark
  imageTransparency : int
Gets or sets the transparency of the watermark's image.
StiWatermark
  ref : int
StiWatermark
  rightToLeft : Boolean
Gets or sets watermark's output direction.
StiWatermark
  showBehind : Boolean
Gets or sets value which indicates where Watermark should be drawing behind or in front of page.
StiWatermark
  showImageBehind : Boolean
Gets or sets value which indicates where Watermark's image should be drawing behind or in front of page.
StiWatermark
  text : String
Gets or sets text of Watermark.
StiWatermark
  textBrush : StiBrush
Gets or sets a brush to Watermark.
StiWatermark
Public Methods
 MethodDefined By
  
StiWatermark(textBrush:StiBrush = null, text:String, angle:Number = 45, font:StiFont = null, showBehind:Boolean = false, enabled:Boolean = true, aspectRatio:Boolean = false, rightToLeft:Boolean = false)
StiWatermark
  
clone(... args):Object
[override]
StiWatermark
  
equals(object:Object):Boolean
[override]
StiWatermark
 Inherited
Get a short object type name (without library path).
StiObject
 Inherited
getType():Class
StiObject
 Inherited
getTypeName():String
StiObject
 Inherited
isSimple(object:*):Boolean
[static]
StiObject
  
[override]
StiWatermark
Property Detail
angleproperty
angle:Number

Gets or sets angle of Watermark.


Implementation
    public function get angle():Number
    public function set angle(value:Number):void
aspectRatioproperty 
aspectRatio:Boolean

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


Implementation
    public function get aspectRatio():Boolean
    public function set aspectRatio(value:Boolean):void
enabledproperty 
enabled:Boolean

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


Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
fontproperty 
font:StiFont

Gets or sets font of Watermark.


Implementation
    public function get font():StiFont
    public function set font(value:StiFont):void
imageproperty 
image:String

Gets or sets value watermark's image.


Implementation
    public function get image():String
    public function set image(value:String):void
imageAlignmentproperty 
imageAlignment:int

Gets or sets the watermark's image alignment.


Implementation
    public function get imageAlignment():int
    public function set imageAlignment(value:int):void
imageBitmapproperty 
imageBitmap:BitmapData


Implementation
    public function get imageBitmap():BitmapData
    public function set imageBitmap(value:BitmapData):void
imageMultipleFactorproperty 
imageMultipleFactor:Number

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


Implementation
    public function get imageMultipleFactor():Number
    public function set imageMultipleFactor(value:Number):void
imageStretchproperty 
imageStretch:Boolean

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


Implementation
    public function get imageStretch():Boolean
    public function set imageStretch(value:Boolean):void
imageTilingproperty 
imageTiling:Boolean

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


Implementation
    public function get imageTiling():Boolean
    public function set imageTiling(value:Boolean):void
imageToDrawproperty 
imageToDraw:String


Implementation
    public function get imageToDraw():String
    public function set imageToDraw(value:String):void
imageTransparencyproperty 
imageTransparency:int

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


Implementation
    public function get imageTransparency():int
    public function set imageTransparency(value:int):void
refproperty 
ref:int


Implementation
    public function get ref():int
    public function set ref(value:int):void
rightToLeftproperty 
rightToLeft:Boolean

Gets or sets watermark's output direction.


Implementation
    public function get rightToLeft():Boolean
    public function set rightToLeft(value:Boolean):void
showBehindproperty 
showBehind:Boolean

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


Implementation
    public function get showBehind():Boolean
    public function set showBehind(value:Boolean):void
showImageBehindproperty 
showImageBehind:Boolean

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


Implementation
    public function get showImageBehind():Boolean
    public function set showImageBehind(value:Boolean):void
textproperty 
text:String

Gets or sets text of Watermark.


Implementation
    public function get text():String
    public function set text(value:String):void
textBrushproperty 
textBrush:StiBrush

Gets or sets a brush to Watermark.


Implementation
    public function get textBrush():StiBrush
    public function set textBrush(value:StiBrush):void
Constructor Detail
StiWatermark()Constructor
public function StiWatermark(textBrush:StiBrush = null, text:String, angle:Number = 45, font:StiFont = null, showBehind:Boolean = false, enabled:Boolean = true, aspectRatio:Boolean = false, rightToLeft:Boolean = false)



Parameters
textBrush:StiBrush (default = null)
 
text:String
 
angle:Number (default = 45)
 
font:StiFont (default = null)
 
showBehind:Boolean (default = false)
 
enabled:Boolean (default = true)
 
aspectRatio:Boolean (default = false)
 
rightToLeft:Boolean (default = false)
Method Detail
clone()method
override public function clone(... args):Object

Parameters

... args

Returns
Object
equals()method 
override public function equals(object:Object):Boolean

Parameters

object:Object

Returns
Boolean
memberwiseClone()method 
override public function memberwiseClone():Object

Returns
Object