TPTP 4.5.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.chart.internal
Class DefaultChartRenderData

java.lang.Object
  extended by org.eclipse.tptp.platform.report.chart.internal.DefaultChartRenderData

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 DefaultChartRenderData
extends java.lang.Object

Contains metrics and (dynamic) data to render the chart part of a DGraphic.


Field Summary
 int axis_dot_size
          Deprecated.  
 int axis_title_to_unit_spacing
          Deprecated.  
 int axis_unit_dot_size
          Deprecated.  
 int axis_unit_to_dot_spacing
          Deprecated.  
 boolean draw_
          Deprecated.  
 IGC gc_
          Deprecated.  
 IGCDirect gd_
          Deprecated.  
 int lx_
          Deprecated.  
 int ly_
          Deprecated.  
 int margin_
          Deprecated. margin for render
 int max_axis_dot_size
          Deprecated.  
 float scale_
          Deprecated.  
 
Constructor Summary
DefaultChartRenderData(boolean _draw, IGC _gc, float _scale)
          Deprecated.  
 
Method Summary
 Insets computeXAxisAmounts(DAxis _axis, IScale _scale, Rect _R, int _title_alignment, Insets _insets)
          Deprecated. Compute and return amounts (border) required to render an horinzontal axis at the bottom of rectangle _R.
 Insets computeYAxisAmounts(boolean vertical, boolean _left, DAxis _axis, IScale _scale, Rect _R, int _title_alignment, Insets _insets)
          Deprecated. Compute and return amounts (border) required to render an vertical/horizontal axis on the left or right side of rectangle _R.
 int dpiX(int x)
          Deprecated.  
 int dpiY(int y)
          Deprecated.  
 boolean drawing()
          Deprecated.  
 void error(java.lang.String _message, RenderPersistData rpd)
          Deprecated. print error occured while rendering chart.
static java.lang.String getAxisTitle(DAxis _axis)
          Deprecated.  
protected  int getLineColor(DAxis axis)
          Deprecated.  
static java.lang.Object getNewInstanceValue(DAxis _axis)
          Deprecated.  
static java.lang.String getResourceString(java.lang.String tag, DI18N i18n)
          Deprecated.  
static IScale getScale(DAxis _axis, double scale_min, double scale_max, java.lang.Object vmin, java.lang.Object vmax)
          Deprecated.  
 boolean locating()
          Deprecated.  
protected  void onXAxis(boolean vertical, Rect _R, DAxis _axis, IScale _scale, java.lang.String _property, IGCDStyle _style)
          Deprecated. Render property on X axis, no support for "3D-like".
protected  void onYAxis(boolean vertical, boolean _left, Rect _R, DAxis _axis, IScale _scale, java.lang.String _property, IGCDStyle _style, int _3d_line_x, int _3d_line_y)
          Deprecated. Render property on Y axis (left/or right side of graph), support for "3D-like" only for left Y axis.
 void renderBar(boolean vertical, Rect r, int _back_rgba, IDItem _item, int _3d_z)
          Deprecated. Render (draw or locate) bar, rectangle with "3d" effect,.
 void renderMarkerLine(boolean axis_vertical, boolean for_draw, DAxis axis, Rect area, IScale scale)
          Deprecated. renders the marker line for an axis
 void renderSectorText(double _angle, double _ray, Rect _rc, java.lang.String _txt, IDItem _item, IGCDStyle _style, java.lang.String _located)
          Deprecated. Render text for a sector (PieChart and Histor,...).
 void renderText(java.lang.String _text, Rect _rect, int _align, IGCDStyle _style, java.lang.String _locid, IDItem _item)
          Deprecated. Draw or locate for an horizontal/vertical text.
 void renderXAxis(boolean _for_draw, boolean vertical, DAxis _axis, IScale _scale, Rect _R, Insets _insets, IGCDStyle _style, int _title_alignment)
          Deprecated. Render an X axis (bottom): DOT/UNIT/LINES and titles.
protected  void renderXAxisTitle(boolean vertical, DAxis _axis, Rect _R, Insets _insets, IGCDStyle _style, int _title_alignment)
          Deprecated. Render X axis title for bottom axis only.
 void renderYAxis(boolean vertical, boolean _for_draw, boolean _left, DAxis _axis, IScale _scale, Rect _R, Insets _insets, IGCDStyle _style, int _title_alignment, int _3d_line_x, int _3D_line_y)
          Deprecated. Render an Y axis (left): DOT/UNIT/LINES and titles.
protected  void renderYAxisTitle(boolean vertical, boolean _left, DAxis _axis, Rect _R, Insets _insets, IGCDStyle _style, int _title_alignment)
          Deprecated. Render Y axis title for right axis only.
 void setupMargin(DGraphic _graphic)
          Deprecated.  
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

axis_title_to_unit_spacing

public final int axis_title_to_unit_spacing
Deprecated. 

axis_unit_to_dot_spacing

public final int axis_unit_to_dot_spacing
Deprecated. 

axis_dot_size

public final int axis_dot_size
Deprecated. 

axis_unit_dot_size

public final int axis_unit_dot_size
Deprecated. 

max_axis_dot_size

public final int max_axis_dot_size
Deprecated. 

margin_

public int margin_
Deprecated. 
margin for render


draw_

public boolean draw_
Deprecated. 

gc_

public IGC gc_
Deprecated. 

gd_

public IGCDirect gd_
Deprecated. 

scale_

public float scale_
Deprecated. 

lx_

public int lx_
Deprecated. 

ly_

public int ly_
Deprecated. 
Constructor Detail

DefaultChartRenderData

public DefaultChartRenderData(boolean _draw,
                              IGC _gc,
                              float _scale)
Deprecated. 
Method Detail

drawing

public boolean drawing()
Deprecated. 
Returns:
true if render is in drawing mode

locating

public boolean locating()
Deprecated. 
Returns:
true if render is in locating mode

setupMargin

public void setupMargin(DGraphic _graphic)
Deprecated. 

error

public void error(java.lang.String _message,
                  RenderPersistData rpd)
Deprecated. 
print error occured while rendering chart.


dpiX

public int dpiX(int x)
Deprecated. 

dpiY

public int dpiY(int y)
Deprecated. 

getLineColor

protected int getLineColor(DAxis axis)
Deprecated. 
Returns:
line RGBA color from P_LINE_COLOR property or lightGray by default.

renderText

public void renderText(java.lang.String _text,
                       Rect _rect,
                       int _align,
                       IGCDStyle _style,
                       java.lang.String _locid,
                       IDItem _item)
                throws DefaultRenderChartLocation
Deprecated. 
Draw or locate for an horizontal/vertical text.

Parameters:
_text - text to render.
_rect - rectangle to draw text
_align - LEFT/RIGHT/HCENTER/... flag
_style - style to paint
_locid - identifier for location
_item - item for location
Throws:
DefaultRenderChartLocation

getResourceString

public static java.lang.String getResourceString(java.lang.String tag,
                                                 DI18N i18n)
Deprecated. 
Returns:
a text contained in a resourcebundle file

getAxisTitle

public static java.lang.String getAxisTitle(DAxis _axis)
Deprecated. 
Returns:
the title to display for axis "title (unit)" or "(unit)" or null.

computeXAxisAmounts

public Insets computeXAxisAmounts(DAxis _axis,
                                  IScale _scale,
                                  Rect _R,
                                  int _title_alignment,
                                  Insets _insets)
Deprecated. 
Compute and return amounts (border) required to render an horinzontal axis at the bottom of rectangle _R. Axis font must be set in current gc_. A configured pixel scale is requiered to get min/max values and units text locations. Amounts get bounds from untruncated texts.


computeYAxisAmounts

public Insets computeYAxisAmounts(boolean vertical,
                                  boolean _left,
                                  DAxis _axis,
                                  IScale _scale,
                                  Rect _R,
                                  int _title_alignment,
                                  Insets _insets)
Deprecated. 
Compute and return amounts (border) required to render an vertical/horizontal axis on the left or right side of rectangle _R. Axis font must be set in current gc_. A configured pixel scale is requiered to get min/max values and units text locations. Amounts get bounds from untruncated texts.


renderXAxis

public void renderXAxis(boolean _for_draw,
                        boolean vertical,
                        DAxis _axis,
                        IScale _scale,
                        Rect _R,
                        Insets _insets,
                        IGCDStyle _style,
                        int _title_alignment)
                 throws DefaultRenderChartLocation
Deprecated. 
Render an X axis (bottom): DOT/UNIT/LINES and titles. Rectangle, scale and amounts must be computed/updated before calling this method.

Throws:
DefaultRenderChartLocation

renderYAxis

public void renderYAxis(boolean vertical,
                        boolean _for_draw,
                        boolean _left,
                        DAxis _axis,
                        IScale _scale,
                        Rect _R,
                        Insets _insets,
                        IGCDStyle _style,
                        int _title_alignment,
                        int _3d_line_x,
                        int _3D_line_y)
                 throws DefaultRenderChartLocation
Deprecated. 
Render an Y axis (left): DOT/UNIT/LINES and titles. Rectangle, scale and amounts must be computed/updated before calling this method.

Throws:
DefaultRenderChartLocation

renderXAxisTitle

protected void renderXAxisTitle(boolean vertical,
                                DAxis _axis,
                                Rect _R,
                                Insets _insets,
                                IGCDStyle _style,
                                int _title_alignment)
                         throws DefaultRenderChartLocation
Deprecated. 
Render X axis title for bottom axis only.

Throws:
DefaultRenderChartLocation

renderYAxisTitle

protected void renderYAxisTitle(boolean vertical,
                                boolean _left,
                                DAxis _axis,
                                Rect _R,
                                Insets _insets,
                                IGCDStyle _style,
                                int _title_alignment)
                         throws DefaultRenderChartLocation
Deprecated. 
Render Y axis title for right axis only.

Throws:
DefaultRenderChartLocation

getScale

public static IScale getScale(DAxis _axis,
                              double scale_min,
                              double scale_max,
                              java.lang.Object vmin,
                              java.lang.Object vmax)
Deprecated. 
Returns:
a scale for given DAxis, linear by default (if axis's type isn't known). return a LinearDateScale for Date objects.

getNewInstanceValue

public static java.lang.Object getNewInstanceValue(DAxis _axis)
Deprecated. 
Returns:
an object suitable to get/set stored values in this axis. Simple axis return a VDouble(), if property P_DATA_CLASS is set, try to create an instance of this class. For others case ... return null. Ok, it's not important to understand this, only chart renders have to..

onXAxis

protected void onXAxis(boolean vertical,
                       Rect _R,
                       DAxis _axis,
                       IScale _scale,
                       java.lang.String _property,
                       IGCDStyle _style)
                throws DefaultRenderChartLocation
Deprecated. 
Render property on X axis, no support for "3D-like".

Parameters:
_R - rectangle to render axis.
_axis - axis to render.
_property - property identifier to render: STEP_LINE,STEP_UNIT,STEP_DOT.
Throws:
DefaultRenderChartLocation

onYAxis

protected void onYAxis(boolean vertical,
                       boolean _left,
                       Rect _R,
                       DAxis _axis,
                       IScale _scale,
                       java.lang.String _property,
                       IGCDStyle _style,
                       int _3d_line_x,
                       int _3d_line_y)
                throws DefaultRenderChartLocation
Deprecated. 
Render property on Y axis (left/or right side of graph), support for "3D-like" only for left Y axis.

Parameters:
_left - true to render property for a left axis
_get_step_unit_width - true to compute step unit width on axis, false to locate/draw.
_R - rectangle to render axis.
_axis - axis to render.
_property - property identifier to render: STEP_LINE,STEP_UNIT,STEP_DOT.
_3d_line_x - simulated 3d on x axis
_3d_line_y - simulated 3d on y axis
Throws:
DefaultRenderChartLocation

renderBar

public void renderBar(boolean vertical,
                      Rect r,
                      int _back_rgba,
                      IDItem _item,
                      int _3d_z)
               throws DefaultRenderChartLocation
Deprecated. 
Render (draw or locate) bar, rectangle with "3d" effect,.

Parameters:
_r - main rectangle of bar.
_style - used to draw bar
_item - thrown for locating mode.
_3d_z, - if not 0 draw 3d (right/top) area.
Throws:
DefaultRenderChartLocation

renderSectorText

public void renderSectorText(double _angle,
                             double _ray,
                             Rect _rc,
                             java.lang.String _txt,
                             IDItem _item,
                             IGCDStyle _style,
                             java.lang.String _located)
                      throws DefaultRenderChartLocation
Deprecated. 
Render text for a sector (PieChart and Histor,...).

Parameters:
_angle - angle where texte is drawn (in radian)
_ray - is distangle where text is drawn from center (must include margin if needed)
_rc - rectangle where the sector are drawn
_txt - text to render
_point - item for location purpose
_style - to render text
Throws:
DefaultRenderChartLocation

renderMarkerLine

public void renderMarkerLine(boolean axis_vertical,
                             boolean for_draw,
                             DAxis axis,
                             Rect area,
                             IScale scale)
                      throws DefaultRenderChartLocation
Deprecated. 
renders the marker line for an axis

Throws:
DefaultRenderChartLocation

TPTP 4.5.0 Platform Project
Internal API Specification