TPTP 4.5.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.core.internal
Class DWallpaper

java.lang.Object
  extended by org.eclipse.tptp.platform.report.core.internal.DWallpaper
All Implemented Interfaces:
IDObject, IDStringSerializable, IDWallpaper

Deprecated. As of TPTP 4.5.0, use the TPTP Business Intelligence and Reporting Tools (BIRT) reporting infrastructure (org.eclipse.tptp.platform.report.birt).

public class DWallpaper
extends java.lang.Object
implements IDWallpaper, IDObject

IDWallpaper implementation. Define a background image using various effect as position,repeat, scale... Those effect can be used (by a driver) to render image in a rectangle.


Field Summary
static int BORDER
          Deprecated. override any other effect, the image is drawn repeatly in the inside of rectangle
static int BOTTOM
          Deprecated. place the image at the bottom of the rendering rectangle
static int CENTER
          Deprecated. combined mask
static int DEFAULT
          Deprecated.  
static int HCENTER
          Deprecated. place image in the center horizontally (this is the default, if nor LEFT neither RIGHT is used)
static int HREPEAT
          Deprecated. repeat image horizontally to fit rectnagle width. left, right or hscale can be used with hrepeat
static int HSCALE
          Deprecated. the image is extended/reduced to fit the rectangle width.
static int LAST
          Deprecated. last valid effect value
static int LEFT
          Deprecated. place the image on the left side of rendering rectangle
static int REPEAT
          Deprecated.  
static int RIGHT
          Deprecated. place the image on the right side of rendering rectangle
static int SCALE
          Deprecated.  
static int TOP
          Deprecated. place the image at the top of rendering rectangle
static int VCENTER
          Deprecated. place image in the center vertically (this is the default, if nor TOP neither BOTTOM is used)
static int VREPEAT
          Deprecated. same as HREPEAT for rectangle height
static int VSCALE
          Deprecated. same as HSCALE for rectangle height
 
Constructor Summary
DWallpaper(java.lang.String name)
          Deprecated. Create a wallpaper using default effect.
DWallpaper(java.lang.String name, int effect)
          Deprecated. Create a wallpaper using given image and effect.
 
Method Summary
 int getEffect()
          Deprecated. Returns the effect applied on the wall paper
 java.lang.String getName()
          Deprecated. Returns the name of the Wall Pager
 boolean haveEffect(int mask)
          Deprecated.  
static boolean HaveEffect(int effect, int mask)
          Deprecated.  
 boolean isEffect(int mask)
          Deprecated.  
static boolean IsEffect(int effect, int mask)
          Deprecated.  
 void serializeFromString(java.lang.String str)
          Deprecated. Reset wallpaper to default, and try to configure from speficied string.
 java.lang.String serializeToString()
          Deprecated. return string with wallpaper configuration
 void setEffect(int effect)
          Deprecated. Change effect value of wallpaper.
 void setName(java.lang.String name)
          Deprecated. Change the image name of the wallpaper.
static int ToEffect(java.lang.String str)
          Deprecated.  
static java.lang.String ToString(int effect)
          Deprecated.  
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HCENTER

public static int HCENTER
Deprecated. 
place image in the center horizontally (this is the default, if nor LEFT neither RIGHT is used)


VCENTER

public static int VCENTER
Deprecated. 
place image in the center vertically (this is the default, if nor TOP neither BOTTOM is used)


LEFT

public static int LEFT
Deprecated. 
place the image on the left side of rendering rectangle


RIGHT

public static int RIGHT
Deprecated. 
place the image on the right side of rendering rectangle


HSCALE

public static int HSCALE
Deprecated. 
the image is extended/reduced to fit the rectangle width. if HREPEAT is used with, an integer number of image is used (ie the image can be scaled)


TOP

public static int TOP
Deprecated. 
place the image at the top of rendering rectangle


BOTTOM

public static int BOTTOM
Deprecated. 
place the image at the bottom of the rendering rectangle


VSCALE

public static int VSCALE
Deprecated. 
same as HSCALE for rectangle height


HREPEAT

public static int HREPEAT
Deprecated. 
repeat image horizontally to fit rectnagle width. left, right or hscale can be used with hrepeat


VREPEAT

public static int VREPEAT
Deprecated. 
same as HREPEAT for rectangle height


BORDER

public static int BORDER
Deprecated. 
override any other effect, the image is drawn repeatly in the inside of rectangle


LAST

public static int LAST
Deprecated. 
last valid effect value


CENTER

public static int CENTER
Deprecated. 
combined mask


SCALE

public static int SCALE
Deprecated. 

REPEAT

public static int REPEAT
Deprecated. 

DEFAULT

public static int DEFAULT
Deprecated. 
Constructor Detail

DWallpaper

public DWallpaper(java.lang.String name)
Deprecated. 
Create a wallpaper using default effect.


DWallpaper

public DWallpaper(java.lang.String name,
                  int effect)
Deprecated. 
Create a wallpaper using given image and effect. Effect is a or'ed (|) mask using one of effect defined (LEFT,TOP,...)

Method Detail

getName

public java.lang.String getName()
Deprecated. 
Description copied from interface: IDWallpaper
Returns the name of the Wall Pager

Specified by:
getName in interface IDWallpaper
Returns:
current image name of the wallpaper

setName

public void setName(java.lang.String name)
Deprecated. 
Change the image name of the wallpaper.


getEffect

public int getEffect()
Deprecated. 
Description copied from interface: IDWallpaper
Returns the effect applied on the wall paper

Specified by:
getEffect in interface IDWallpaper
Returns:
current effect value.

setEffect

public void setEffect(int effect)
Deprecated. 
Change effect value of wallpaper.


isEffect

public boolean isEffect(int mask)
Deprecated. 
Returns:
true if effect have all the given effect mask.

haveEffect

public boolean haveEffect(int mask)
Deprecated. 
Returns:
true if effect have at least one of the effect in given mask.

IsEffect

public static boolean IsEffect(int effect,
                               int mask)
Deprecated. 
Returns:
true if effect have all the effect set in mask.

HaveEffect

public static boolean HaveEffect(int effect,
                                 int mask)
Deprecated. 
Returns:
true if effect have one (or more) effect in the given mask.

ToString

public static java.lang.String ToString(int effect)
Deprecated. 
Returns:
string representation from effect, use name and '|' character.

ToEffect

public static int ToEffect(java.lang.String str)
Deprecated. 
Returns:
effect parsed in given string (used effect name and '|'.

serializeToString

public java.lang.String serializeToString()
Deprecated. 
return string with wallpaper configuration

Specified by:
serializeToString in interface IDStringSerializable

serializeFromString

public void serializeFromString(java.lang.String str)
Deprecated. 
Reset wallpaper to default, and try to configure from speficied string.

Specified by:
serializeFromString in interface IDStringSerializable

TPTP 4.5.0 Platform Project
Internal API Specification