TPTP 4.5.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.igc.internal
Interface IGC

All Known Implementing Classes:
AWTGC, OGC, SVGGC, SWTGC

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 interface IGC

Interface defining what can be drawn over a pixel space. SWT's user will find this close to GC class, AWT's one close to Graphics one. By convention, x axis is from left to right, y axis is from top to bottom angles are in radian (as java.lang.Math.cos() and others likes). Positive angle are counter-clockwise, negative are clockwise, 0 is at 3 O'clock. IGC use a Pen/Brush system to define color or "texture". Pen is used to draw line and pathpath (ie drawRect,drawCircle,...). Brush is used to fill shape (ie fillRect, fillCircle...), and draw texts (drawText()).


Field Summary
static int C_INFO_BACKGROUND
          Deprecated. Color used to paint tooltip background areas
static int C_INFO_FOREGROUND
          Deprecated. Color used to paint tooltip text
static int C_LIST_BACKGROUND
          Deprecated. Color used to paint list background areas
static int C_LIST_FOREGROUND
          Deprecated. Color used to paint list foreground areas
static int C_LIST_SELECTION_BACKGROUND
          Deprecated. Color used to paint list selection background areas
static int C_LIST_SELECTION_TEXT
          Deprecated. Color used to paint list selected text
static int C_TITLE_BACKGROUND
          Deprecated. Color used to paint title background areas
static int C_TITLE_BACKGROUND_GRADIENT
          Deprecated. Color used to paint title background gradient
static int C_TITLE_FOREGROUND
          Deprecated. Color used to paint title text
static int C_TITLE_INACTIVE_BACKGROUND
          Deprecated. Color used to paint inactive title background areas
static int C_TITLE_INACTIVE_BACKGROUND_GRADIENT
          Deprecated. Color used to paint inactive title background gradient
static int C_TITLE_INACTIVE_FOREGROUND
          Deprecated. Color used to paint inactive title text
static int C_WIDGET_BACKGROUND
          Deprecated. Color used to paint background areas
static int C_WIDGET_BORDER
          Deprecated. Color used to paint border areas
static int C_WIDGET_DARK_SHADOW
          Deprecated. Color used to paint dark shadow areas.
static int C_WIDGET_FOREGROUND
          Deprecated. Color used to paint foreground areas
static int C_WIDGET_HIGHLIGHT_SHADOW
          Deprecated. Color used to paint highlight shadow areas.
static int C_WIDGET_LIGHT_SHADOW
          Deprecated. Color used to paint light shadow areas
static int C_WIDGET_NORMAL_SHADOW
          Deprecated. Color used to paint normal shadow areas
 
Method Summary
 void drawArc(int xc, int yc, double _r1_angle, int r1, int r2, double _start_angle, double _arc_length)
          Deprecated. draw an oriented arc defined by start angle and length (>0 means counter-clockwise in the sense (1,0)>(0,1)).
 void drawCircle(int cx, int cy, int radius)
          Deprecated. Draw a circle of radius and centered at (cx,cy) using current brush or color.
 void drawEllipse(int xc, int yc, double _r1_angle, int r1, int r2)
          Deprecated. Draw an oriented ellipse, not necessary coordinate aligned one.
 void drawFocus(int x, int y, int w, int h)
          Deprecated. Draw the focus with rectangle coordinates
 void drawFocus(IRect rect)
          Deprecated. Draw the focus with rectangle object
 void drawImage(IImage image, int x, int y)
          Deprecated. draw image at given location
 void drawImage(IImage image, int x, int y, int w, int h)
          Deprecated. draw image resized to a rectangle
 void drawImage(IImage image, int srcX, int srcY, int srcW, int srcH, int dstX, int dstY, int dstW, int dstH)
          Deprecated. draw part of image resized to a rectangle
 void drawLine(int x1, int y1, int x2, int y2)
          Deprecated. Draw a line using current pen. points are expressed in pixel coordinates
 void drawOval(int x, int y, int w, int h)
          Deprecated. Draw using current brush or color the oval defined inside given rectangle.
 void drawPath(IPath path)
          Deprecated. draw path using current pen (note: unknown or unsupported path will be ignored).
 void drawPoint(int x, int y)
          Deprecated. Draw pixel at location (x,y) using current brush
 void drawPoly(IPolygon poly)
          Deprecated. draw the polygon using current brush or color.
 void drawRect(int x, int y, int w, int h)
          Deprecated. Draw the outline of rectangle using current pen.
 void drawRect(IRect r)
          Deprecated. Draw the outline of rectangle using current pen.
 void drawText(java.lang.String text, int x, int y)
          Deprecated. Draw text at given location, x,y is the upper left corner, using current brush.
 void drawText(java.lang.String text, int x, int y, double angle)
          Deprecated. Draw rotated text at given location (upper left corner of text)., using current brush.
 void fillArc(int xc, int yc, double _r1_angle, int r1, int r2, double _start_angle, double _arc_length)
          Deprecated. fill an oriented arc defined by start angle and length (>0 means counter-clockwise in the sense (1,0)>(0,1)).
 void fillCircle(int cx, int cy, int radius)
          Deprecated. Fill circle using current brush or color
 void fillEllipse(int xc, int yc, double _r1_angle, int r1, int r2)
          Deprecated. Fill an oriented ellipse, not necessary coordinate aligned one.
 void fillOval(int x, int y, int w, int h)
          Deprecated. Fill using current brush or color the oval defined inside given rectangle.
 void fillPoly(IPolygon poly)
          Deprecated. fill the polygon using current brush or color.
 void fillRect(int x, int y, int w, int h)
          Deprecated. Fill rectangle including outline using current brush (@see IRect for rectangle definition).
 void fillRect(IRect r)
          Deprecated. Fill rectangle including outline using current brush
 void fillShape(IShape shape)
          Deprecated. fill shape using current brush (note: unknown or unsupported shape will be ignored).
 IBrush getBrush()
          Deprecated.  
 IShape getClipping()
          Deprecated.  
 IFont getFont()
          Deprecated.  
 IFontMetrics getFontMetrics()
          Deprecated.  
 IGCDirect getIGCDirect()
          Deprecated.  
 IPen getPen()
          Deprecated.  
 int getPoint(int x, int y)
          Deprecated.  
 int getSystemColor(int id)
          Deprecated. Return system color for given id.
 IBrush setBrush(IBrush brush)
          Deprecated. Change brush and return previous one (can be null).
 IShape setClipping(IShape shape)
          Deprecated. Change current clipping area, and return previous one.
 IFont setFont(IFont font)
          Deprecated. Change current font and return previous one (can be null)
 IPen setPen(IPen pen)
          Deprecated. Change pen used by this render, @return previous pen
 ISize textExtent(java.lang.String text)
          Deprecated.  
 ISize textExtent(java.lang.String text, double angle)
          Deprecated.  
 IPolygon textExtent(java.lang.String text, int x, int y, double angle)
          Deprecated.  
 

Field Detail

C_WIDGET_DARK_SHADOW

static final int C_WIDGET_DARK_SHADOW
Deprecated. 
Color used to paint dark shadow areas.

See Also:
Constant Field Values

C_WIDGET_NORMAL_SHADOW

static final int C_WIDGET_NORMAL_SHADOW
Deprecated. 
Color used to paint normal shadow areas

See Also:
Constant Field Values

C_WIDGET_LIGHT_SHADOW

static final int C_WIDGET_LIGHT_SHADOW
Deprecated. 
Color used to paint light shadow areas

See Also:
Constant Field Values

C_WIDGET_HIGHLIGHT_SHADOW

static final int C_WIDGET_HIGHLIGHT_SHADOW
Deprecated. 
Color used to paint highlight shadow areas.

See Also:
Constant Field Values

C_WIDGET_FOREGROUND

static final int C_WIDGET_FOREGROUND
Deprecated. 
Color used to paint foreground areas

See Also:
Constant Field Values

C_WIDGET_BACKGROUND

static final int C_WIDGET_BACKGROUND
Deprecated. 
Color used to paint background areas

See Also:
Constant Field Values

C_WIDGET_BORDER

static final int C_WIDGET_BORDER
Deprecated. 
Color used to paint border areas

See Also:
Constant Field Values

C_LIST_FOREGROUND

static final int C_LIST_FOREGROUND
Deprecated. 
Color used to paint list foreground areas

See Also:
Constant Field Values

C_LIST_BACKGROUND

static final int C_LIST_BACKGROUND
Deprecated. 
Color used to paint list background areas

See Also:
Constant Field Values

C_LIST_SELECTION_BACKGROUND

static final int C_LIST_SELECTION_BACKGROUND
Deprecated. 
Color used to paint list selection background areas

See Also:
Constant Field Values

C_LIST_SELECTION_TEXT

static final int C_LIST_SELECTION_TEXT
Deprecated. 
Color used to paint list selected text

See Also:
Constant Field Values

C_INFO_FOREGROUND

static final int C_INFO_FOREGROUND
Deprecated. 
Color used to paint tooltip text

See Also:
Constant Field Values

C_INFO_BACKGROUND

static final int C_INFO_BACKGROUND
Deprecated. 
Color used to paint tooltip background areas

See Also:
Constant Field Values

C_TITLE_FOREGROUND

static final int C_TITLE_FOREGROUND
Deprecated. 
Color used to paint title text

See Also:
Constant Field Values

C_TITLE_BACKGROUND

static final int C_TITLE_BACKGROUND
Deprecated. 
Color used to paint title background areas

See Also:
Constant Field Values

C_TITLE_BACKGROUND_GRADIENT

static final int C_TITLE_BACKGROUND_GRADIENT
Deprecated. 
Color used to paint title background gradient

See Also:
Constant Field Values

C_TITLE_INACTIVE_FOREGROUND

static final int C_TITLE_INACTIVE_FOREGROUND
Deprecated. 
Color used to paint inactive title text

See Also:
Constant Field Values

C_TITLE_INACTIVE_BACKGROUND

static final int C_TITLE_INACTIVE_BACKGROUND
Deprecated. 
Color used to paint inactive title background areas

See Also:
Constant Field Values

C_TITLE_INACTIVE_BACKGROUND_GRADIENT

static final int C_TITLE_INACTIVE_BACKGROUND_GRADIENT
Deprecated. 
Color used to paint inactive title background gradient

See Also:
Constant Field Values
Method Detail

getBrush

IBrush getBrush()
Deprecated. 
Returns:
current brush, or null if no brush are used

setBrush

IBrush setBrush(IBrush brush)
Deprecated. 
Change brush and return previous one (can be null). Brush are used to fill shapes (rectangles, ellipse.,...). Remember that setBrush will copy brush, you need to set all brush parameters before calling setBrush().


getPen

IPen getPen()
Deprecated. 
Returns:
curren pen, or null is no pen are used

setPen

IPen setPen(IPen pen)
Deprecated. 
Change pen used by this render, @return previous pen


getFont

IFont getFont()
Deprecated. 
Returns:
current font used by drawText.

setFont

IFont setFont(IFont font)
Deprecated. 
Change current font and return previous one (can be null)


getFontMetrics

IFontMetrics getFontMetrics()
Deprecated. 
Returns:
current font metrics

drawLine

void drawLine(int x1,
              int y1,
              int x2,
              int y2)
Deprecated. 
Draw a line using current pen. points are expressed in pixel coordinates


getPoint

int getPoint(int x,
             int y)
Deprecated. 
Parameters:
x - coordinate of point to get color.
y - coorindate of point to get color.
Returns:
current pixel color (RGBA) at (x,y), 0 if requested point is outside.

drawPoint

void drawPoint(int x,
               int y)
Deprecated. 
Draw pixel at location (x,y) using current brush


drawCircle

void drawCircle(int cx,
                int cy,
                int radius)
Deprecated. 
Draw a circle of radius and centered at (cx,cy) using current brush or color.


fillCircle

void fillCircle(int cx,
                int cy,
                int radius)
Deprecated. 
Fill circle using current brush or color


drawOval

void drawOval(int x,
              int y,
              int w,
              int h)
Deprecated. 
Draw using current brush or color the oval defined inside given rectangle.


fillOval

void fillOval(int x,
              int y,
              int w,
              int h)
Deprecated. 
Fill using current brush or color the oval defined inside given rectangle.


drawArc

void drawArc(int xc,
             int yc,
             double _r1_angle,
             int r1,
             int r2,
             double _start_angle,
             double _arc_length)
Deprecated. 
draw an oriented arc defined by start angle and length (>0 means counter-clockwise in the sense (1,0)>(0,1)).

Parameters:
xc - X center of the ellipse.
yc - Y center of the ellipse.
_r1_angle - angle of main radius (r1) from X coordinate axis.
r1 - main radius
r2 - secondary radius (90 degree from r1)
_start_angle - start angle of arc 0 is 3 O'clock position
_arc_length - arc length from start angle >0 for counter-clockwise, 2*PI for full ellipse.

fillArc

void fillArc(int xc,
             int yc,
             double _r1_angle,
             int r1,
             int r2,
             double _start_angle,
             double _arc_length)
Deprecated. 
fill an oriented arc defined by start angle and length (>0 means counter-clockwise in the sense (1,0)>(0,1)). Fill include the center of ellipse.

Parameters:
xc - X center of the ellipse.
yc - Y center of the ellipse.
_r1_angle - angle of main radius (r1) from X coordinate axis.
r1 - main radius
r2 - secondary radius (90 degree from r1)
_start_angle - start angle (radian) of arc 0 is 3 O'clock position
_arc_length - arc length (radian) from start angle >0 for counter-clockwise, 2*PI for full ellipse.

drawEllipse

void drawEllipse(int xc,
                 int yc,
                 double _r1_angle,
                 int r1,
                 int r2)
Deprecated. 
Draw an oriented ellipse, not necessary coordinate aligned one.

Parameters:
xc - X center of the ellipse.
yc - Y center of the ellipse.
_r1_angle - angle of main radius (r1) from X coordinate axis.
r1 - main radius
r2 - secondary radius (90 degree from r1)

fillEllipse

void fillEllipse(int xc,
                 int yc,
                 double _r1_angle,
                 int r1,
                 int r2)
Deprecated. 
Fill an oriented ellipse, not necessary coordinate aligned one.

Parameters:
xc - X center of the ellipse.
yc - Y center of the ellipse.
_r1_angle - angle (radian) of main radius (r1) from X coordinate axis.
r1 - main radius
r2 - secondary radius (90 degree from r1)

fillRect

void fillRect(int x,
              int y,
              int w,
              int h)
Deprecated. 
Fill rectangle including outline using current brush (@see IRect for rectangle definition).


drawRect

void drawRect(int x,
              int y,
              int w,
              int h)
Deprecated. 
Draw the outline of rectangle using current pen.


fillRect

void fillRect(IRect r)
Deprecated. 
Fill rectangle including outline using current brush


drawRect

void drawRect(IRect r)
Deprecated. 
Draw the outline of rectangle using current pen.


fillShape

void fillShape(IShape shape)
Deprecated. 
fill shape using current brush (note: unknown or unsupported shape will be ignored).


drawPath

void drawPath(IPath path)
Deprecated. 
draw path using current pen (note: unknown or unsupported path will be ignored).


drawImage

void drawImage(IImage image,
               int x,
               int y)
Deprecated. 
draw image at given location


drawImage

void drawImage(IImage image,
               int x,
               int y,
               int w,
               int h)
Deprecated. 
draw image resized to a rectangle


drawImage

void drawImage(IImage image,
               int srcX,
               int srcY,
               int srcW,
               int srcH,
               int dstX,
               int dstY,
               int dstW,
               int dstH)
Deprecated. 
draw part of image resized to a rectangle


drawPoly

void drawPoly(IPolygon poly)
Deprecated. 
draw the polygon using current brush or color.


fillPoly

void fillPoly(IPolygon poly)
Deprecated. 
fill the polygon using current brush or color.


textExtent

ISize textExtent(java.lang.String text)
Deprecated. 
Returns:
size of text bounding box in pixels

drawText

void drawText(java.lang.String text,
              int x,
              int y)
Deprecated. 
Draw text at given location, x,y is the upper left corner, using current brush.


textExtent

ISize textExtent(java.lang.String text,
                 double angle)
Deprecated. 
Returns:
size of rotated text using given angle (in radian), or null if rotation is not supported.

textExtent

IPolygon textExtent(java.lang.String text,
                    int x,
                    int y,
                    double angle)
Deprecated. 
Returns:
rotated text bounding polygon in pixels, using given angle (radian). null is rotation is not supported. (x,y) is where text will be drawn, (top left corner of text before rotation). By convention, first point must be top-left corner of text (x,y), second one is top right corner, third is bottom right and last one if bottom left corner, more points can be returned, but only the fourth first are mandatory. If you want to get size of rotated text, use IPolygon.getBounds();

drawText

void drawText(java.lang.String text,
              int x,
              int y,
              double angle)
Deprecated. 
Draw rotated text at given location (upper left corner of text)., using current brush.


drawFocus

void drawFocus(int x,
               int y,
               int w,
               int h)
Deprecated. 
Draw the focus with rectangle coordinates


drawFocus

void drawFocus(IRect rect)
Deprecated. 
Draw the focus with rectangle object


getClipping

IShape getClipping()
Deprecated. 
Returns:
current clipping area, null if none

setClipping

IShape setClipping(IShape shape)
Deprecated. 
Change current clipping area, and return previous one.


getIGCDirect

IGCDirect getIGCDirect()
Deprecated. 
Returns:
IGCDirect interface used by this IGC.

getSystemColor

int getSystemColor(int id)
Deprecated. 
Return system color for given id.
Note: for constant color as white,red,... use RGBA class instead.

Parameters:
id - identifiant of system color, see C_xxx constants
Returns:
rgba color defined in system for given id.
See Also:
class.

TPTP 4.5.0 Platform Project
Internal API Specification