TPTP 4.5.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.drawutil.internal
Interface ISymbol

All Known Implementing Classes:
ISymbol.Cross, ISymbol.Cross2, ISymbol.Diamond, ISymbol.Down, ISymbol.GeneratedPolygonSymbol, ISymbol.Hexagon, ISymbol.HexagonCross, ISymbol.HexagonCross2, ISymbol.HTri2, ISymbol.Left, ISymbol.Minus, ISymbol.MoonDown, ISymbol.MoonLeft, ISymbol.MoonRight, ISymbol.MoonUp, ISymbol.Oval, ISymbol.OvalDot, ISymbol.Pentagon, ISymbol.Plus, ISymbol.PolygonSymbol, ISymbol.Right, ISymbol.Square, ISymbol.Square2, ISymbol.Star, ISymbol.Up, ISymbol.VTri2

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 ISymbol

A Symbol a shape, it must support: - drawing inside a rectangle (@see draw) - checking if a point is inside or not in the symbol's shape (@see contains) Any static class defining standards symbol are provided: - Square, Oval (circle), triangles (Up,Left,Right,Down), Plus (cross), ... - Polygon abstract class can be subclassed for any polygon shaped symbol.


Nested Class Summary
static class ISymbol.Cross
          Deprecated. Cross look like 4 triangles.
static class ISymbol.Cross2
          Deprecated. Cross look like 4 triangles, like a Cross with "45? rotated"...
static class ISymbol.Diamond
          Deprecated. Diamong symbol, simpler named lozenge.
static class ISymbol.Down
          Deprecated. Downward triangle symbol
static class ISymbol.GeneratedPolygonSymbol
          Deprecated. Abstract class for symbol using generator.
static class ISymbol.Hexagon
          Deprecated. Hexagon
static class ISymbol.HexagonCross
          Deprecated. Hexagon cross look like 3 triangles.
static class ISymbol.HexagonCross2
          Deprecated. Hexagon cross look like 3 triangles (reversed)
static class ISymbol.HTri2
          Deprecated. two horizontal triangles
static class ISymbol.Left
          Deprecated. Leftward triangle symbol
static class ISymbol.Minus
          Deprecated. Minus, covering 1/3 of rectangle height.
static class ISymbol.MoonDown
          Deprecated. Define down-half-Oval symbol
static class ISymbol.MoonLeft
          Deprecated. Define left-half-oval family symbol
static class ISymbol.MoonRight
          Deprecated. Define right family symbol
static class ISymbol.MoonUp
          Deprecated. Define up-half-oval symbol
static class ISymbol.Oval
          Deprecated. Define Oval family symbol, can be used for a circle symbol (set rectangle's width=height).
static class ISymbol.OvalDot
          Deprecated. Define OvalDot family symbol, can be used for a circle symbol (set rectangle's width=height), having a dot inside.
static class ISymbol.Pentagon
          Deprecated. Pentagon
static class ISymbol.Plus
          Deprecated. Plus, or cross symbol
static class ISymbol.PolygonSymbol
          Deprecated. Polygon shaped symbol.
static class ISymbol.Right
          Deprecated. Rightward triangle symbol
static class ISymbol.Square
          Deprecated. Define a square symbol (a rectangle), this is the simpliest symbol.
static class ISymbol.Square2
          Deprecated. Define a square symbol (a rectangle), with a second rectangle inside.
static class ISymbol.Star
          Deprecated. Star, a 5 branch star.
static class ISymbol.Up
          Deprecated. Upward triangle symbol
static class ISymbol.VTri2
          Deprecated. two vertical triangles
 
Method Summary
 boolean contains(IGC gc, IRect rect, int px, int py)
          Deprecated.  
 void draw(IGC gc, IRect rect)
          Deprecated. Draw the symbol using igc's current pen and brush
 java.lang.String getId()
          Deprecated.  
 

Method Detail

draw

void draw(IGC gc,
          IRect rect)
Deprecated. 
Draw the symbol using igc's current pen and brush

Parameters:
gc - the graphic context used to draw the symbol.
rect - the rectangle where the symbol must be drawn.

contains

boolean contains(IGC gc,
                 IRect rect,
                 int px,
                 int py)
Deprecated. 
Parameters:
gc - use this to get any info you want (as text extends ...)
rect - bounding rectangle of the symbol.
px - x coordinate of point to check.
px - y coordinate of point to check.
Returns:
true if point (px,py) is inside symbol.

getId

java.lang.String getId()
Deprecated. 
Returns:
the id associated with this symbol ( a class name is a good idea, for example).

TPTP 4.5.0 Platform Project
Internal API Specification