TPTP 4.5.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.igc.ogc.internal
Class OGC

java.lang.Object
  extended by org.eclipse.tptp.platform.report.igc.ogc.internal.OGC
All Implemented Interfaces:
IGC

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 OGC
extends java.lang.Object
implements IGC

TODO !!! UNDER TEST / DEVELOPMENT ... implementation of IGC using an off screen buffer, this IGC support transparency (this IGC implementor use none of swt.GC method). User of this GC must call getBuffer() to get off screen buffer and draw it on their real GC. Support clipping using IRect only. OGC need an adapter to the underlaying graphic system.

See Also:
IOGCAdapter.

Field Summary
protected  int background_rgba_
          Deprecated.  
protected  IBrush brush_
          Deprecated. current brush used, null if not already created.
protected  int[] buf_
          Deprecated. offscreen buffer, use one dimension array as it's really better than a two dimension array.
protected  FillPolygonAlg fill_poly_alg_
          Deprecated.  
protected  IFont font_
          Deprecated. current font used, null if not created
protected  IGCDirect gd_
          Deprecated. used IGCDirect
protected  int height_
          Deprecated.  
protected  LineAlg line_alg_
          Deprecated.  
protected  Oval oval_
          Deprecated.  
protected  IPen pen_
          Deprecated. current pen used, null if not already created.
protected  int width_
          Deprecated.  
 
Fields inherited from interface org.eclipse.tptp.platform.report.igc.internal.IGC
C_INFO_BACKGROUND, C_INFO_FOREGROUND, C_LIST_BACKGROUND, C_LIST_FOREGROUND, C_LIST_SELECTION_BACKGROUND, C_LIST_SELECTION_TEXT, C_TITLE_BACKGROUND, C_TITLE_BACKGROUND_GRADIENT, C_TITLE_FOREGROUND, C_TITLE_INACTIVE_BACKGROUND, C_TITLE_INACTIVE_BACKGROUND_GRADIENT, C_TITLE_INACTIVE_FOREGROUND, C_WIDGET_BACKGROUND, C_WIDGET_BORDER, C_WIDGET_DARK_SHADOW, C_WIDGET_FOREGROUND, C_WIDGET_HIGHLIGHT_SHADOW, C_WIDGET_LIGHT_SHADOW, C_WIDGET_NORMAL_SHADOW
 
Constructor Summary
OGC(IOGCAdapter adapter, int width, int height, int background_rgba)
          Deprecated. Create an Extended SWTGC, device is used for internal image creation, widthxheight off screen buffer size.
 
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 a dashed rectangle with the rectangle coordinates with XOR mode
 void drawFocus(IRect rect)
          Deprecated. Draw the focus with rectangle object.
 void drawImage(IImage image, int _x, int _y)
          Deprecated. Support for ImageProxy and SWTImage.
 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. If path is a IPolygon, use drawPoly().
 void drawPoint(int x, int y)
          Deprecated. Draw pixel at location (x,y) using current brush
 void drawPoly(IPolygon poly)
          Deprecated. If current pen is a LineStylePen use swt.gc.drawPolyline.
 void drawRect(int x, int y, int w, int h)
          Deprecated. If current pen is null or a LineStylePen, use swt.GC.drawRectangle().
 void drawRect(IRect r)
          Deprecated. Draw the outline of rectangle using current pen.
 void drawText(java.lang.String text, int _x, int _y)
          Deprecated. Use current pen to draw font, force transparency if current brush is null.
 void drawText(java.lang.String text, int x, int y, double angle)
          Deprecated. Support any angles.
protected  void drawTextImage(RGBAImage data, int devx, int devy, boolean transparent)
          Deprecated. devx,devy is top left corner of image (!
 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. If shape is an IRect, IOval call fillRect/fillOval instead.
 boolean fillShapeInternal(IShape shape)
          Deprecated.  
 IBrush getBrush()
          Deprecated.  
 RGBAImage getBuffer()
          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.
protected  boolean haveNoBrush()
          Deprecated.  
protected  boolean haveNoPen()
          Deprecated.  
 void resize(int width, int height)
          Deprecated. resize off screen image used and fill it using background color.
 void restart()
          Deprecated. fill current buffer with background color
 IBrush setBrush(IBrush _brush)
          Deprecated. Change current brush, special support for SolidBrush and SWTFillGradientRectangleBrush, others will be used/or not depending on shape to fill.
 IShape setClipping(IShape s)
          Deprecated. Change current clipping area, and return previous one.
 IFont setFont(IFont font)
          Deprecated. support all IFont.
 IPen setPen(IPen _pen)
          Deprecated. Change current pen, special supports for:
-LineStylePen: use directly swt.GC. methods.
 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.  
protected  void Unsupported(java.lang.String what)
          Deprecated.  
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

brush_

protected IBrush brush_
Deprecated. 
current brush used, null if not already created.


pen_

protected IPen pen_
Deprecated. 
current pen used, null if not already created.


font_

protected IFont font_
Deprecated. 
current font used, null if not created


gd_

protected IGCDirect gd_
Deprecated. 
used IGCDirect


width_

protected int width_
Deprecated. 

height_

protected int height_
Deprecated. 

background_rgba_

protected int background_rgba_
Deprecated. 

buf_

protected int[] buf_
Deprecated. 
offscreen buffer, use one dimension array as it's really better than a two dimension array.


line_alg_

protected LineAlg line_alg_
Deprecated. 

oval_

protected Oval oval_
Deprecated. 

fill_poly_alg_

protected FillPolygonAlg fill_poly_alg_
Deprecated. 
Constructor Detail

OGC

public OGC(IOGCAdapter adapter,
           int width,
           int height,
           int background_rgba)
Deprecated. 
Create an Extended SWTGC, device is used for internal image creation, widthxheight off screen buffer size.

Parameters:
background_rgba - color used to initialize buffer, must not contains transparency.
Method Detail

haveNoBrush

protected boolean haveNoBrush()
Deprecated. 
Returns:
true if current brush is null or a SolidBrush with invisible color

haveNoPen

protected boolean haveNoPen()
Deprecated. 
Returns:
true if current pen is null or a LineStylePen with invisible color

getIGCDirect

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

resize

public void resize(int width,
                   int height)
Deprecated. 
resize off screen image used and fill it using background color.


restart

public void restart()
Deprecated. 
fill current buffer with background color


getBuffer

public RGBAImage getBuffer()
Deprecated. 

getBrush

public IBrush getBrush()
Deprecated. 
Specified by:
getBrush in interface IGC
Returns:
current brush, or null if no brush are used

setBrush

public IBrush setBrush(IBrush _brush)
Deprecated. 
Change current brush, special support for SolidBrush and SWTFillGradientRectangleBrush, others will be used/or not depending on shape to fill. GradientBrush is used for fillRect() method only

Specified by:
setBrush in interface IGC
See Also:
IGC.setBrush(org.eclipse.tptp.platform.report.igc.internal.IBrush)

getPen

public IPen getPen()
Deprecated. 
Specified by:
getPen in interface IGC
Returns:
curren pen, or null is no pen are used

setPen

public IPen setPen(IPen _pen)
Deprecated. 
Change current pen, special supports for:
-LineStylePen: use directly swt.GC. methods.
Others are taken into account depending on path to draw.

Specified by:
setPen in interface IGC
See Also:
IGC.setPen(org.eclipse.tptp.platform.report.igc.internal.IPen)

drawLine

public void drawLine(int x1,
                     int y1,
                     int x2,
                     int y2)
Deprecated. 
Description copied from interface: IGC
Draw a line using current pen. points are expressed in pixel coordinates

Specified by:
drawLine in interface IGC

getPoint

public int getPoint(int x,
                    int y)
Deprecated. 
Specified by:
getPoint in interface IGC
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

public void drawPoint(int x,
                      int y)
Deprecated. 
Description copied from interface: IGC
Draw pixel at location (x,y) using current brush

Specified by:
drawPoint in interface IGC

drawCircle

public void drawCircle(int cx,
                       int cy,
                       int radius)
Deprecated. 
Description copied from interface: IGC
Draw a circle of radius and centered at (cx,cy) using current brush or color.

Specified by:
drawCircle in interface IGC

fillCircle

public void fillCircle(int cx,
                       int cy,
                       int radius)
Deprecated. 
Description copied from interface: IGC
Fill circle using current brush or color

Specified by:
fillCircle in interface IGC

drawOval

public void drawOval(int x,
                     int y,
                     int w,
                     int h)
Deprecated. 
Description copied from interface: IGC
Draw using current brush or color the oval defined inside given rectangle.

Specified by:
drawOval in interface IGC

fillOval

public void fillOval(int x,
                     int y,
                     int w,
                     int h)
Deprecated. 
Description copied from interface: IGC
Fill using current brush or color the oval defined inside given rectangle.

Specified by:
fillOval in interface IGC

drawArc

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

Specified by:
drawArc in interface IGC
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

public void fillArc(int xc,
                    int yc,
                    double _r1_angle,
                    int r1,
                    int r2,
                    double _start_angle,
                    double _arc_length)
Deprecated. 
Description copied from interface: IGC
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.

Specified by:
fillArc in interface IGC
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

public void drawEllipse(int xc,
                        int yc,
                        double _r1_angle,
                        int r1,
                        int r2)
Deprecated. 
Description copied from interface: IGC
Draw an oriented ellipse, not necessary coordinate aligned one.

Specified by:
drawEllipse in interface IGC
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

public void fillEllipse(int xc,
                        int yc,
                        double _r1_angle,
                        int r1,
                        int r2)
Deprecated. 
Description copied from interface: IGC
Fill an oriented ellipse, not necessary coordinate aligned one.

Specified by:
fillEllipse in interface IGC
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)

drawRect

public void drawRect(int x,
                     int y,
                     int w,
                     int h)
Deprecated. 
If current pen is null or a LineStylePen, use swt.GC.drawRectangle(). Otherwise use pen's methods.

Specified by:
drawRect in interface IGC
See Also:
IGC.drawRect(int, int, int, int)

fillRect

public void fillRect(IRect r)
Deprecated. 
Description copied from interface: IGC
Fill rectangle including outline using current brush

Specified by:
fillRect in interface IGC

drawRect

public void drawRect(IRect r)
Deprecated. 
Description copied from interface: IGC
Draw the outline of rectangle using current pen.

Specified by:
drawRect in interface IGC

fillRect

public void fillRect(int x,
                     int y,
                     int w,
                     int h)
Deprecated. 
Description copied from interface: IGC
Fill rectangle including outline using current brush (@see IRect for rectangle definition).

Specified by:
fillRect in interface IGC

drawImage

public void drawImage(IImage image,
                      int _x,
                      int _y)
Deprecated. 
Support for ImageProxy and SWTImage.

Specified by:
drawImage in interface IGC
See Also:
org.eclipse.tptp.platform.report.igc.internal.IGC#drawImage(int, int, org.eclipse.tptp.platform.report.igc.internal.IImage)

drawImage

public void drawImage(IImage _image,
                      int _x,
                      int _y,
                      int _w,
                      int _h)
Deprecated. 
Description copied from interface: IGC
draw image resized to a rectangle

Specified by:
drawImage in interface IGC

drawImage

public void drawImage(IImage image,
                      int srcX,
                      int srcY,
                      int srcW,
                      int srcH,
                      int dstX,
                      int dstY,
                      int dstW,
                      int dstH)
Deprecated. 
Description copied from interface: IGC
draw part of image resized to a rectangle

Specified by:
drawImage in interface IGC

drawPoly

public void drawPoly(IPolygon poly)
Deprecated. 
If current pen is a LineStylePen use swt.gc.drawPolyline. If polygon is a IPath: - If pen implements IGCHelperDrawPath, try to use this drawPath(). - If polygon implements IGCHelperDrawPath, try to use this drawPath().

Specified by:
drawPoly in interface IGC
See Also:
IGC.drawPoly(org.eclipse.tptp.platform.report.igc.internal.IPolygon)

fillPoly

public void fillPoly(IPolygon poly)
Deprecated. 
Description copied from interface: IGC
fill the polygon using current brush or color.

Specified by:
fillPoly in interface IGC

textExtent

public ISize textExtent(java.lang.String text)
Deprecated. 
Specified by:
textExtent in interface IGC
Returns:
size of text bounding box in pixels

textExtent

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

textExtent

public IPolygon textExtent(java.lang.String text,
                           int x,
                           int y,
                           double angle)
Deprecated. 
Specified by:
textExtent in interface IGC
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();

drawTextImage

protected void drawTextImage(RGBAImage data,
                             int devx,
                             int devy,
                             boolean transparent)
Deprecated. 
devx,devy is top left corner of image (! be careful)


drawText

public void drawText(java.lang.String text,
                     int _x,
                     int _y)
Deprecated. 
Use current pen to draw font, force transparency if current brush is null. current pen must be a LineStylePen.

Specified by:
drawText in interface IGC
See Also:
IGC.drawText(java.lang.String, int, int )

drawText

public void drawText(java.lang.String text,
                     int x,
                     int y,
                     double angle)
Deprecated. 
Support any angles.

Specified by:
drawText in interface IGC
See Also:
IGC.drawText(java.lang.String, int, int, double)

drawFocus

public void drawFocus(int x,
                      int y,
                      int w,
                      int h)
Deprecated. 
Draw a dashed rectangle with the rectangle coordinates with XOR mode

Specified by:
drawFocus in interface IGC

drawFocus

public void drawFocus(IRect rect)
Deprecated. 
Draw the focus with rectangle object. Call drawFocus(x,y,w,h)

Specified by:
drawFocus in interface IGC
See Also:
drawFocus(int, int, int, int)

getFont

public IFont getFont()
Deprecated. 
Specified by:
getFont in interface IGC
Returns:
current font used by drawText.

setFont

public IFont setFont(IFont font)
Deprecated. 
support all IFont.

Specified by:
setFont in interface IGC
See Also:
IGC.setFont(org.eclipse.tptp.platform.report.igc.internal.IFont)

getFontMetrics

public IFontMetrics getFontMetrics()
Deprecated. 
Specified by:
getFontMetrics in interface IGC
Returns:
current font metrics

getClipping

public IShape getClipping()
Deprecated. 
Specified by:
getClipping in interface IGC
Returns:
current clipping area, null if none

setClipping

public IShape setClipping(IShape s)
Deprecated. 
Description copied from interface: IGC
Change current clipping area, and return previous one.

Specified by:
setClipping in interface IGC

fillShapeInternal

public boolean fillShapeInternal(IShape shape)
Deprecated. 

fillShape

public void fillShape(IShape shape)
Deprecated. 
If shape is an IRect, IOval call fillRect/fillOval instead. If current brush implements IShapeFiller, call brush_.fillShape(). If shape implements IShapeFiller, call shape.fillShape(). Otherwise fill nothing.

Specified by:
fillShape in interface IGC

drawPath

public void drawPath(IPath path)
Deprecated. 
If path is a IPolygon, use drawPoly(). If pen implements IGCHelperDrawPath try to use it. If path implements IGCHelperDrawPath try to use it. Otherwise draw nothing.

Specified by:
drawPath in interface IGC

Unsupported

protected void Unsupported(java.lang.String what)
Deprecated. 

getSystemColor

public int getSystemColor(int id)
Deprecated. 
Description copied from interface: IGC
Return system color for given id.
Note: for constant color as white,red,... use RGBA class instead.

Specified by:
getSystemColor in interface IGC
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