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

java.lang.Object
  org.eclipse.tptp.platform.report.core.internal.DItem
      org.eclipse.tptp.platform.report.core.internal.DItemContainer
          org.eclipse.tptp.platform.report.core.internal.DAxis

All Implemented Interfaces:

IDItem, IDObject

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 DAxis
extends DItemContainer

Axis is used to store coordinates in point. Axis are child or DGraphic. For example two dimensional graphic displaying XY curve, contains two axis (one for x, one for y). Point coordinate can't be defined without axis, that's why even for simple graphics like histograms, an axis is required. Axis is named: expected to be unic for all axis of a graphic (name means identifier). Axis have a title and a unit that can be displayed to user. Axis can use linear or logarythmic scale. Axis can use float (or integer) values or java.util.Date values. Axis contains properties like min/max values (after a document update), or steps (line,unit,dot) for display purpose. For a logarythmic scaled axis steps must be in ]0..10[ and configure which line (unit,dot) is displayed for this decade 1..10, others are known by multiplying (dividing) by 10. For example a step_unit of 5 means the followings units text will be used 1,5,10,50,100,500,1000,.... For a date axis steps can be long (delay in milliseconds), or an instance of CalendarField to express usual steps like "every 6 month".

See Also:

DPoint, DCoord, DCurve, DGraphic

Field Summary

static java.lang.String	P_DATA_CLASS Deprecated. property key for a Class that set data type for this axis, float by default.
static java.lang.String	P_DATA_SCALE_PROVIDER Deprecated. property key for a IScaleProvider you can set to instanciate particular IScale.
static java.lang.String	P_HISTORS_UNIT Deprecated. property key for an IDAlignment object used only to render P_STEP_UNIT for T_HISTORS graphics.
static java.lang.String	P_HISTORS_UNIT_OPAQUE Deprecated. property key for a Boolean object used only to render P_STEP_UNIT for T_HISTORS graphics.
static java.lang.String	P_LABEL_ALIGNMENT Deprecated. property key for an IDAlignment object used only to align label on T_HISTOGRAM and T_HISTOGRAM_IM graphics.
static java.lang.String	P_LABEL_FORMAT Deprecated. property key for a string object which defines the pattern used to draw the axis label By default the value is null Only activated for the SVG generation
static java.lang.String	P_LABEL_FORMATTYPE Deprecated. property key for a string object which defines the label type (number, date) the axis label By default the value is null Only activated for the SVG generation
static java.lang.String	P_LABEL_ROTATION Deprecated. property key for a string which defines the rotation angle for the axis label.
static java.lang.String	P_LINE_COLOR Deprecated. property key for a IDColor instance that configure color used to render STEP_LINE in a different color than axis's style foreground.
static java.lang.String	P_MAJUNIT_SHOWGRID Deprecated. property key for a boolean to show or not the grid line for the major unit.
static java.lang.String	P_MAJUNIT_SHOWTICK Deprecated. property key for a boolean to show or not the tick on the axis for the major unit.
static java.lang.String	P_MAJUNIT_VALUE Deprecated. property key for an object compatible with the value contained in the P_DATA_CLASS property.
static java.lang.String	P_MAX Deprecated. property key, after document update, store max coordinate on axis.
static java.lang.String	P_MAX_HINT Deprecated. property key, max. coordinate value asked for axis.
static java.lang.String	P_MIN Deprecated. property key, after document update, store min. value value on this axis.
static java.lang.String	P_MIN_HINT Deprecated. property key, min. coordinate value asked for axis.
static java.lang.String	P_MINUNIT_SHOWGRID Deprecated. property key for a boolean to show or not the grid line for the minor unit.
static java.lang.String	P_MINUNIT_SHOWTICK Deprecated. property key for a boolean to show or not the tick on the axis for the minor unit.
static java.lang.String	P_MINUNIT_VALUE Deprecated. property key for an object compatible with the value contained in the P_DATA_CLASS property.
static java.lang.String	P_SHOW Deprecated. property key for a Boolean object used do draw or not the axis By default this property is true.
static java.lang.String	P_SHOW_TITLE Deprecated. property key for a Boolean object, true if title must be displayed, false to do not.
static java.lang.String	P_STEP_DOT Deprecated. property key, a value asking to display dots each STEP_DOT value (see P_STEP_LINE)
static java.lang.String	P_STEP_LINE Deprecated. property key, an object value asking to display lines each STEP_LINE value.
static java.lang.String	P_STEP_UNIT Deprecated. property key, an object asking to display units each STEP_UNIT value (might be a number).
static java.lang.String	P_UNIT_FORMAT Deprecated. property key for a suitable com.ibm.icu.text.Format class for P_DATA_CLASS.
static java.lang.String	S_LIN Deprecated. Define a linear scale type for axis, this is the default.
static java.lang.String	S_LOG Deprecated. Define a logarythmic scale (for numbers axis only).
static java.lang.String	S_MINUS_NINTY_DEGREE Deprecated. Define a negative 90 degree rotation for the label.
static java.lang.String	S_PLUS_NINTY_DEGREE Deprecated. Define a positive 90 degree rotation for the label.
static java.lang.String	S_ZERO_DEGREE Deprecated. Define a zero degree rotation for the label, this is the default.

Constructor Summary

DAxis(java.lang.String _name)
Deprecated. Create an axis without unit and title.

DAxis(java.lang.String _name, java.lang.String _unit, java.lang.String _title)
Deprecated. Create an axis with a name, an unit and a title.

Method Summary

java.lang.String	getName() Deprecated.
DPropertyStore	getProperties() Deprecated. Returns property store
java.lang.String	getScaleType() Deprecated.
java.lang.String	getTitle() Deprecated.
java.lang.String	getTooltip() Deprecated.
java.lang.String	getUnit() Deprecated.
boolean	isDataClass(java.lang.Class _class) Deprecated.
boolean	isScaleType(java.lang.String _scale) Deprecated.
void	setName(java.lang.String _name) Deprecated. Change the name of the axis.
void	setProperties(DPropertyStore store) Deprecated. Replace current property store in axis.
void	setScaleType(java.lang.String _scale) Deprecated. Changes value of scale type used by this axis.
void	setTitle(java.lang.String _title) Deprecated. Change axis title.
void	setTooltip(java.lang.String tooltip) Deprecated. Sets the text tooltip for the axis
void	setUnit(java.lang.String _unit) Deprecated. Change unit of axis.
boolean	useNumbers() Deprecated.

Methods inherited from class org.eclipse.tptp.platform.report.core.internal.DItemContainer

clear, getChildCount, getChildOfClass, getChildPosition, getChildrenOfClass, getFirstChild, getLastChild, insertChild, isContainer, removeChild

Methods inherited from class org.eclipse.tptp.platform.report.core.internal.DItem

addChild, getAppliedStyle, getIterator, getNext, getParent, getRoot, getStyle, setNext, setParent, setStyle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

P_MIN_HINT

public static final java.lang.String P_MIN_HINT

Deprecated.

property key, min. coordinate value asked for axis. As is an prefered value, graphic render might choose an other value (for example the actual minimum coordinates of points in graphic). (see P_MIN).

See Also:

Constant Field Values

P_MAX_HINT

public static final java.lang.String P_MAX_HINT

Deprecated.

property key, max. coordinate value asked for axis. As is an prefered value, graphic render might choose an other value (for example the actual minimum coordinates of points in graphic). (see P_MAX).

See Also:

Constant Field Values

P_STEP_LINE

public static final java.lang.String P_STEP_LINE

Deprecated.

property key, an object value asking to display lines each STEP_LINE value. Axis using number (float,double) values, set this property with a number. Axis using date values, set this property with a long to express a delay in milliseconds, or with a CalendarField to set simple date steps, for example: "new CalendarField(Calendar.MONTH,6)" to set a step every 6 month.

See Also:

Constant Field Values

P_STEP_UNIT

public static final java.lang.String P_STEP_UNIT

Deprecated.

property key, an object asking to display units each STEP_UNIT value (might be a number). (see P_STEP_LINE)

See Also:

Constant Field Values

P_STEP_DOT

public static final java.lang.String P_STEP_DOT

Deprecated.

property key, a value asking to display dots each STEP_DOT value (see P_STEP_LINE)

See Also:

Constant Field Values

P_MIN

public static final java.lang.String P_MIN

Deprecated.

property key, after document update, store min. value value on this axis. If set graphic render must use this value. (see P_MIN_HINT)

See Also:

Constant Field Values

P_MAX

public static final java.lang.String P_MAX

Deprecated.

property key, after document update, store max coordinate on axis. If set graphic render must use this value. (see P_MAX_HINT)

See Also:

Constant Field Values

P_SHOW_TITLE

public static final java.lang.String P_SHOW_TITLE

Deprecated.

property key for a Boolean object, true if title must be displayed, false to do not. If property isn't set (default), the axis's title is displayed.

See Also:

Constant Field Values

P_LINE_COLOR

public static final java.lang.String P_LINE_COLOR

Deprecated.

property key for a IDColor instance that configure color used to render STEP_LINE in a different color than axis's style foreground.

See Also:

Constant Field Values

P_DATA_CLASS

public static final java.lang.String P_DATA_CLASS

Deprecated.

property key for a Class that set data type for this axis, float by default. For a date axis set this property with "Date.class"

See Also:

Constant Field Values

P_DATA_SCALE_PROVIDER

public static final java.lang.String P_DATA_SCALE_PROVIDER

Deprecated.

property key for a IScaleProvider you can set to instanciate particular IScale. This is mandatory for unhandled P_DATA_CLASS you set (ie: not for java.util.Date, or if !DAxis.useNumbers().

See Also:

Constant Field Values

P_UNIT_FORMAT

public static final java.lang.String P_UNIT_FORMAT

Deprecated.

property key for a suitable com.ibm.icu.text.Format class for P_DATA_CLASS. For example: DAxis can use com.ibm.icu.text.DecimalFormat if it's using decimal values, or for a Date value use com.ibm.icu.text.DateFormat. By default, if axis use number a DecimalFormat is used, and if axis use Date a SimpleDateFormat is used.

See Also:

Constant Field Values

P_LABEL_ALIGNMENT

public static final java.lang.String P_LABEL_ALIGNMENT

Deprecated.

property key for an IDAlignment object used only to align label on T_HISTOGRAM and T_HISTOGRAM_IM graphics. By default alignment is centered horizontal.

See Also:

to learn how to set labels., Constant Field Values

P_HISTORS_UNIT

public static final java.lang.String P_HISTORS_UNIT

Deprecated.

property key for an IDAlignment object used only to render P_STEP_UNIT for T_HISTORS graphics. Value might be TOP,LEFT,RIGHT,BOTTOM or Or'ed combination of them.
LEFT means units are ROTCCW90, and RIGHT means units are ROTCW90.
By default alignment is the fourth.

See Also:

Constant Field Values

P_HISTORS_UNIT_OPAQUE

public static final java.lang.String P_HISTORS_UNIT_OPAQUE

Deprecated.

property key for a Boolean object used only to render P_STEP_UNIT for T_HISTORS graphics.
false means units are rendered transparent ( circle pass through unit's text).
true means units are rendered opaque using axis applyed style background color.
By default this property is false.

See Also:

Constant Field Values

P_SHOW

public static final java.lang.String P_SHOW

Deprecated.

property key for a Boolean object used do draw or not the axis By default this property is true. Only activated for the SVG generation

See Also:

Constant Field Values

P_LABEL_ROTATION

public static final java.lang.String P_LABEL_ROTATION

Deprecated.

property key for a string which defines the rotation angle for the axis label. By default the value is DAxis.S_ZERO_DEGREE The others values could be DAxis.S_PLUS_NINTY_DEGREE and DAxis.S_MINUS_NINTY_DEGREE Only activated for the SVG generation

See Also:

Constant Field Values

P_MAJUNIT_SHOWTICK

public static final java.lang.String P_MAJUNIT_SHOWTICK

Deprecated.

property key for a boolean to show or not the tick on the axis for the major unit. By default the value is true Only activated for the SVG generation

See Also:

Constant Field Values

P_MAJUNIT_SHOWGRID

public static final java.lang.String P_MAJUNIT_SHOWGRID

Deprecated.

property key for a boolean to show or not the grid line for the major unit. By default the value is true Only activated for the SVG generation

See Also:

Constant Field Values

P_MAJUNIT_VALUE

public static final java.lang.String P_MAJUNIT_VALUE

Deprecated.

property key for an object compatible with the value contained in the P_DATA_CLASS property. The object can be Double, Date and String. By default the value is 0.0. Only activated for the SVG generation

See Also:

Constant Field Values

P_MINUNIT_SHOWTICK

public static final java.lang.String P_MINUNIT_SHOWTICK

Deprecated.

property key for a boolean to show or not the tick on the axis for the minor unit. By default the value is true Only activated for the SVG generation

See Also:

Constant Field Values

P_MINUNIT_SHOWGRID

public static final java.lang.String P_MINUNIT_SHOWGRID

Deprecated.

property key for a boolean to show or not the grid line for the minor unit. By default the value is true Only activated for the SVG generation

See Also:

Constant Field Values

P_MINUNIT_VALUE

public static final java.lang.String P_MINUNIT_VALUE

Deprecated.

property key for an object compatible with the value contained in the P_DATA_CLASS property. The object can be Double, Date and String. By default the value is 0.0 Only activated for the SVG generation

See Also:

Constant Field Values

P_LABEL_FORMAT

public static final java.lang.String P_LABEL_FORMAT

Deprecated.

property key for a string object which defines the pattern used to draw the axis label By default the value is null Only activated for the SVG generation

See Also:

Constant Field Values

P_LABEL_FORMATTYPE

public static final java.lang.String P_LABEL_FORMATTYPE

Deprecated.

property key for a string object which defines the label type (number, date) the axis label By default the value is null Only activated for the SVG generation

See Also:

Constant Field Values

S_LIN

public static final java.lang.String S_LIN

Deprecated.

Define a linear scale type for axis, this is the default.

See Also:

Constant Field Values

S_LOG

public static final java.lang.String S_LOG

Deprecated.

Define a logarythmic scale (for numbers axis only).

See Also:

Constant Field Values

S_ZERO_DEGREE

public static final java.lang.String S_ZERO_DEGREE

Deprecated.

Define a zero degree rotation for the label, this is the default.

See Also:

Constant Field Values

S_PLUS_NINTY_DEGREE

public static final java.lang.String S_PLUS_NINTY_DEGREE

Deprecated.

Define a positive 90 degree rotation for the label.

See Also:

Constant Field Values

S_MINUS_NINTY_DEGREE

public static final java.lang.String S_MINUS_NINTY_DEGREE

Deprecated.

Define a negative 90 degree rotation for the label.

See Also:

Constant Field Values

Constructor Detail

DAxis

public DAxis(java.lang.String _name,
             java.lang.String _unit,
             java.lang.String _title)

Deprecated.

Create an axis with a name, an unit and a title.

Parameters:

_name - name of the axis (ie axis identifier)

_unit - unit for axis

_title - title for axis

DAxis

public DAxis(java.lang.String _name)

Deprecated.

Create an axis without unit and title. Name is required.

Parameters:

_name -

Method Detail

getProperties

public DPropertyStore getProperties()

Deprecated.

Returns property store

getName

public java.lang.String getName()

Deprecated.

Returns:

the name of the axis

setName

public void setName(java.lang.String _name)

Deprecated.

Change the name of the axis. Remember name is expected to be unic in a graphic.

Parameters:

_name - new axis name.

getTitle

public java.lang.String getTitle()

Deprecated.

Returns:

the axis title, can be null.

setTitle

public void setTitle(java.lang.String _title)

Deprecated.

Change axis title.

Parameters:

_title - new axis title.

getUnit

public java.lang.String getUnit()

Deprecated.

Returns:

the unit of axis, can be null.

setUnit

public void setUnit(java.lang.String _unit)

Deprecated.

Change unit of axis.

Parameters:

_unit - new unit of axis.

setProperties

public void setProperties(DPropertyStore store)

Deprecated.

Replace current property store in axis.

Parameters:

store - the new property store.

getScaleType

public java.lang.String getScaleType()

Deprecated.

Returns:

current scale type this axis use.

setScaleType

public void setScaleType(java.lang.String _scale)

Deprecated.

Changes value of scale type used by this axis.

isScaleType

public boolean isScaleType(java.lang.String _scale)

Deprecated.

Returns:

true if the specified scale type is the current in this axis.

useNumbers

public boolean useNumbers()

Deprecated.

Returns:

true if this axis use number as data class (like double, float).

See Also:

P_DATA_CLASS

isDataClass

public boolean isDataClass(java.lang.Class _class)

Deprecated.

Returns:

true is this axis use given class for values. This is known looking P_DATA_CLASS

See Also:

useNumbers()

getTooltip

public java.lang.String getTooltip()

Deprecated.

Returns:

the text tooltip for the axis

setTooltip

public void setTooltip(java.lang.String tooltip)

Deprecated.

Sets the text tooltip for the axis