org.eclipse.tptp.platform.report.chart.svg.internal.part
Class Axis

java.lang.Object
  org.eclipse.tptp.platform.report.chart.svg.internal.generator.SVGBase
      org.eclipse.tptp.platform.report.chart.svg.internal.generator.SVGContainerBase
          org.eclipse.tptp.platform.report.chart.svg.internal.generator.SVGDocumentFragmentBase
              org.eclipse.tptp.platform.report.chart.svg.internal.generator.SVGSvg
                  org.eclipse.tptp.platform.report.chart.svg.internal.part.Part
                      org.eclipse.tptp.platform.report.chart.svg.internal.part.Axis

All Implemented Interfaces:

IConstants, IGraphicTypeConstants, ISVGBase, ISVGContainerBase, ISVGDocumentFragmentBase, java.io.Serializable

Direct Known Subclasses:

AxisCategory, AxisNumber

public abstract class Axis

extends Part

See Also:

Serialized Form

Field Summary

protected AxisDefinition	axisDef axis definition (a pointer to the input DOM)
protected double	axisHeight height of axis
protected double	axisWidth width of axis
protected DataValue	dataValueDef Data value definition (a pointer to the input DOM)
protected double	labelDegrees degrees of label text - horizontal or vertical
protected UnitDefinition	majorUnitDef Major Unit definition from input
protected int	marginForMax
protected UnitDefinition	minorUnitDef Minor Unit definition from input
protected NLString	nls An object for retriving translated text
protected boolean	showMajorGridLines A flag to indicate whether major grid lines should be shown
protected boolean	showMajorTicks A flag to indicate whether major tick marks should be shown
protected boolean	showMinorGridLines A flag to indicate whether minor grid lines should be shown
protected boolean	showMinorTicks A flag to indicate whether minor tick marks should be shown

Fields inherited from class org.eclipse.tptp.platform.report.chart.svg.internal.part.Part

height, input, width, x, y

Fields inherited from interface org.eclipse.tptp.platform.report.chart.svg.internal.part.IConstants

AXIS_LABEL_FONT_SIZE, AXIS_SPACE_BTW_AXIS_AND_LABEL, AXIS_SPACE_BTW_TITLE_AND_LABEL, AXIS_TITLE_FONT_SIZE, AXIS_TYPE_INDEPENDENT_AXIS, AXIS_TYPE_PRIMARY_DEPENDENT_AXIS, AXIS_TYPE_SECONDARY_DEPENDENT_AXIS, BASE_FONT_SIZE, CHART_AREA_DEFAULT_HEIGHT, CHART_AREA_DEFAULT_WIDTH, CHART_AREA_METER_DEFAULT_WIDTH, EMPTY_STRING, GRAPH_AREA_MARGIN, GRAPH_AREA_TOP_MARGIN, HIDDEN, HOLE_RADIUS, HORIZONTAL, LEGEND_HORIZONTAL_HEIGHT, LEGEND_HORIZONTAL_SIDE_MARGIN, LEGEND_HORIZONTAL_TOP_MARGIN, LEGEND_ITEM_FONT_SIZE, LEGEND_ITEMS_PER_ROW, LEGEND_MAX_HEIGHT_FRACTION, LEGEND_MAX_WIDTH_FRACTION, LEGEND_NARROW_SIDE_MARGIN, LEGEND_SPACE_AFTER_TITLE, LEGEND_SPACE_BETWEEN_ITEMS, LEGEND_SPACE_BETWEEN_SYMBOL_AND_TEXT, LEGEND_SYMBOL_LINE_LENGTH, LEGEND_TITLE_FONT_SIZE, LEGEND_VERTICAL_TOP_MARGIN, LEGEND_WIDE_SIDE_MARGIN, MARKER_LINE_DEFAULT_COLOR, PLOT_AREA_MARGIN, POSITION_EAST, POSITION_LEADING, POSITION_NORTH, POSITION_SOUTH, POSITION_TRAILING, POSITION_WEST, TEXT_ANCHOR_END, TEXT_ANCHOR_MIDDLE, TEXT_ANCHOR_START, TICK_MARK_LENGTH, TIMESTAMP_BOTTOM_MARGIN, TIMESTAMP_HEIGHT, TIMESTAMP_SIDE_MARGIN, TITLE_FONT_SIZE, TITLE_HEIGHT, TITLE_PREF_ICON_HEIGHT, TITLE_PREF_ICON_WIDTH, TITLE_SIDE_MARGIN, VERTICAL, VISIBLE

Fields inherited from interface org.eclipse.tptp.platform.report.chart.svg.internal.part.IGraphicTypeConstants

AREA_CHART, HBAR_CHART, HBAR_CHART3D, HSTACKBAR_CHART, HSTACKBAR_CHART3D, LINE_CHART, METER, PIE_CHART, PIE_CHART3D, SCATTER_CHART, STACK_AREA_CHART, VBAR_CHART, VBAR_CHART3D, VSTACKBAR_CHART, VSTACKBAR_CHART3D

Constructor Summary

Axis(Chart input, double x, double y, double width, double height, NLString nls)

Axis(Chart input, NLString nls, double labelDegrees)

Method Summary

double	axisExtendedLength() Returns the extra length of the axes in cases where additional padding is needed
abstract double	getAxisHeight() Gets the Height of the axis part
abstract double	getAxisLength() Gets length of axis
abstract short	getAxisOrientation() Gets the orientation of the axis
abstract double	getAxisWidth() Gets the width of the axis part
double	getLabelDegrees()
int	getMarginForMax()
boolean	isShowMajorGridLines() determines if major grid lines should be drawn
boolean	isShowMinorGridLines() determines if minor grid lines should be drawn
abstract void	setAxisLength(double length) Sets length of axis
abstract void	setCrossPoint(double x, double y) Sets the coordinates of the point where this axis meets with another axis.
void	setLabelDegrees(double labelDegrees)

Methods inherited from class org.eclipse.tptp.platform.report.chart.svg.internal.part.Part

constructPart, doImplementation

Methods inherited from class org.eclipse.tptp.platform.report.chart.svg.internal.generator.SVGSvg

addDefinition, addDefinition, addStyle, doImplementation, doImplementation, doImplementation, getImplementation

Methods inherited from class org.eclipse.tptp.platform.report.chart.svg.internal.generator.SVGDocumentFragmentBase

getHeight, getPreserveAspectRatio, getViewbox, getWidth, getXCoordinate, getYCoordinate, setHeight, setPreserveAspectRatio, setViewbox, setWidth, setXCoordinate, setYCoordinate

Methods inherited from class org.eclipse.tptp.platform.report.chart.svg.internal.generator.SVGContainerBase

getChildren, getDesc, getTitle, setChildren, setDesc, setTitle

Methods inherited from class org.eclipse.tptp.platform.report.chart.svg.internal.generator.SVGBase

getIdentifier, getStyle, getStyleClass, getTagName, getVisibility, setIdentifier, setStyle, setStyleClass, setTagName, setVisibility

Methods inherited from class java.lang.Object

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

Field Detail

labelDegrees

protected double labelDegrees

degrees of label text - horizontal or vertical

axisWidth

protected double axisWidth

width of axis

marginForMax

protected int marginForMax

axisHeight

protected double axisHeight

height of axis

majorUnitDef

protected UnitDefinition majorUnitDef

Major Unit definition from input

minorUnitDef

protected UnitDefinition minorUnitDef

Minor Unit definition from input

showMajorGridLines

protected boolean showMajorGridLines

A flag to indicate whether major grid lines should be shown

showMinorGridLines

protected boolean showMinorGridLines

A flag to indicate whether minor grid lines should be shown

showMajorTicks

protected boolean showMajorTicks

A flag to indicate whether major tick marks should be shown

showMinorTicks

protected boolean showMinorTicks

A flag to indicate whether minor tick marks should be shown

axisDef

protected AxisDefinition axisDef

axis definition (a pointer to the input DOM)

dataValueDef

protected DataValue dataValueDef

Data value definition (a pointer to the input DOM)

nls

protected NLString nls

An object for retriving translated text

Constructor Detail

Axis

public Axis(Chart input,
            NLString nls,
            double labelDegrees)

Parameters:

input -

Axis

public Axis(Chart input,
            double x,
            double y,
            double width,
            double height,
            NLString nls)

Parameters:

input -

x -

y -

width -

height -

Method Detail

getAxisLength

public abstract double getAxisLength()

Gets length of axis

Returns:

setAxisLength

public abstract void setAxisLength(double length)

Sets length of axis

Parameters:

length -

getAxisWidth

public abstract double getAxisWidth()

Gets the width of the axis part

Returns:

getAxisHeight

public abstract double getAxisHeight()

Gets the Height of the axis part

Returns:

setCrossPoint

public abstract void setCrossPoint(double x,
                                   double y)

Sets the coordinates of the point where this axis meets with another axis.

Parameters:

x -

y -

isShowMajorGridLines

public boolean isShowMajorGridLines()

determines if major grid lines should be drawn

Returns:

true if major grid lines should be drawn

isShowMinorGridLines

public boolean isShowMinorGridLines()

determines if minor grid lines should be drawn

Returns:

true if minor grid lines should be drawn

getAxisOrientation

public abstract short getAxisOrientation()

Gets the orientation of the axis

Returns:

orientation

axisExtendedLength

public double axisExtendedLength()

Returns the extra length of the axes in cases where additional padding is needed

Returns:

getMarginForMax

public int getMarginForMax()

getLabelDegrees

public double getLabelDegrees()

Returns:

Returns the labelDegrees.

setLabelDegrees

public void setLabelDegrees(double labelDegrees)

Parameters:

labelDegrees - The labelDegrees to set.