TPTP 4.5.0 Platform Project
Internal API Specification

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

java.lang.Object
  extended by org.eclipse.tptp.platform.report.chart.svg.internal.generator.SVGBase
      extended by org.eclipse.tptp.platform.report.chart.svg.internal.generator.SVGContainerBase
          extended by org.eclipse.tptp.platform.report.chart.svg.internal.generator.SVGDocumentFragmentBase
              extended by org.eclipse.tptp.platform.report.chart.svg.internal.generator.SVGSvg
                  extended by org.eclipse.tptp.platform.report.chart.svg.internal.part.Part
                      extended by org.eclipse.tptp.platform.report.chart.svg.internal.part.Axis
                          extended by org.eclipse.tptp.platform.report.chart.svg.internal.part.AxisNumber
                              extended by org.eclipse.tptp.platform.report.chart.svg.internal.part.AxisNumberHorizontal
All Implemented Interfaces:
java.io.Serializable, ISVGBase, ISVGContainerBase, ISVGDocumentFragmentBase, IConstants, IGraphicTypeConstants
Direct Known Subclasses:
AxisNumberHorizontal3D

public class AxisNumberHorizontal
extends AxisNumber

See Also:
Serialized Form

Field Summary
protected  java.lang.String topString
           
 
Fields inherited from class org.eclipse.tptp.platform.report.chart.svg.internal.part.AxisNumber
axisType, cumulative, customPattern, dataMax, dataMin, datasets, isLinear, labelOrientation, labels, majorUnit, majorUnitValues, max, maxLabelHeight, maxLabelLength, min, minorUnit, minorUnitValues, timezone, title, TOP_MARGIN
 
Fields inherited from class org.eclipse.tptp.platform.report.chart.svg.internal.part.Axis
axisDef, axisHeight, axisWidth, dataValueDef, labelDegrees, majorUnitDef, marginForMax, minorUnitDef, nls, showMajorGridLines, showMajorTicks, showMinorGridLines, showMinorTicks
 
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
AxisNumberHorizontal(Chart input, boolean isLTR, java.util.List datasets, short axisType, boolean cumulative, NLString nls)
           
AxisNumberHorizontal(Chart input, boolean isLTR, java.util.List datasets, short axisType, boolean cumulative, short labelOrientation, NLString nls)
           
 
Method Summary
 double axisExtendedLength()
          Returns the extra length of the axes in cases where additional padding is needed
protected  void constructPart()
           
protected  SVGBase drawHorizontalLabels(double[] positions)
          Constructs horizontal labels
protected  SVGBase drawTickMarks()
           
protected  SVGBase drawVerticalLabels(double[] positions)
          Constructs vertical labels
 double getAxisHeight()
          Gets the Height of the axis part
 double getAxisLength()
          Get axis length
 short getAxisOrientation()
          Get axis orientation
 double getAxisWidth()
          Gets the width of the axis part
 int getMarginForMax()
          Since half of the label of the max value goes beyond the right edge of the plot area, we need to find the margin required to display the full text of the max label.
protected  double getXCoordinate(double value, double max_coor, double min_coor, double max, double min)
          Calculate coordinate in linear scale
 void setAxisLength(double length)
          Sets the length of the axis.
 void setCrossPoint(double x, double y)
          Given the coordinates, relative to the parent container, of the crossing point of the two axes, translate the axis part to the approprate position.
 
Methods inherited from class org.eclipse.tptp.platform.report.chart.svg.internal.part.AxisNumber
formatValue, getLabelHeight, getLabelWidth, getMajorUnitValues, getMax, getMin, getMinorUnitValues, getTickMarkValuesAndLabels, isLinear, setLabelDegrees
 
Methods inherited from class org.eclipse.tptp.platform.report.chart.svg.internal.part.Axis
getLabelDegrees, isShowMajorGridLines, isShowMinorGridLines
 
Methods inherited from class org.eclipse.tptp.platform.report.chart.svg.internal.part.Part
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

topString

protected java.lang.String topString
Constructor Detail

AxisNumberHorizontal

public AxisNumberHorizontal(Chart input,
                            boolean isLTR,
                            java.util.List datasets,
                            short axisType,
                            boolean cumulative,
                            NLString nls)
Parameters:
input -
datasets -
axisType -
cumulative -

AxisNumberHorizontal

public AxisNumberHorizontal(Chart input,
                            boolean isLTR,
                            java.util.List datasets,
                            short axisType,
                            boolean cumulative,
                            short labelOrientation,
                            NLString nls)
Parameters:
input -
datasets -
axisType -
cumulative -
labelOrientation -
Method Detail

getMarginForMax

public int getMarginForMax()
Description copied from class: AxisNumber
Since half of the label of the max value goes beyond the right edge of the plot area, we need to find the margin required to display the full text of the max label.

Overrides:
getMarginForMax in class AxisNumber
Returns:
length of half of the formatted max value

setAxisLength

public void setAxisLength(double length)
Description copied from class: AxisNumber
Sets the length of the axis. The method is used by the parent container. The information is dependent on other axes.

Specified by:
setAxisLength in class AxisNumber

getAxisLength

public double getAxisLength()
Description copied from class: AxisNumber
Get axis length

Specified by:
getAxisLength in class AxisNumber
Returns:
axis length

setCrossPoint

public void setCrossPoint(double x,
                          double y)
Description copied from class: AxisNumber
Given the coordinates, relative to the parent container, of the crossing point of the two axes, translate the axis part to the approprate position.

Specified by:
setCrossPoint in class AxisNumber

drawHorizontalLabels

protected SVGBase drawHorizontalLabels(double[] positions)
Description copied from class: AxisNumber
Constructs horizontal labels

Specified by:
drawHorizontalLabels in class AxisNumber
Returns:

drawVerticalLabels

protected SVGBase drawVerticalLabels(double[] positions)
Description copied from class: AxisNumber
Constructs vertical labels

Specified by:
drawVerticalLabels in class AxisNumber
Returns:

getAxisOrientation

public short getAxisOrientation()
Description copied from class: AxisNumber
Get axis orientation

Specified by:
getAxisOrientation in class AxisNumber
Returns:
axis orientation

getAxisWidth

public double getAxisWidth()
Description copied from class: Axis
Gets the width of the axis part

Specified by:
getAxisWidth in class Axis
Returns:

getAxisHeight

public double getAxisHeight()
Description copied from class: Axis
Gets the Height of the axis part

Specified by:
getAxisHeight in class Axis
Returns:

constructPart

protected void constructPart()
Specified by:
constructPart in class Part

getXCoordinate

protected double getXCoordinate(double value,
                                double max_coor,
                                double min_coor,
                                double max,
                                double min)
Calculate coordinate in linear scale

Parameters:
value - value to be plotted
max_coor - coordinate of the maximum value of this axis
min_coor - coordinate of the minimum value of this axis
max - maximum value of this axis
min - minimum value of this axis
Returns:

drawTickMarks

protected SVGBase drawTickMarks()

axisExtendedLength

public double axisExtendedLength()
Description copied from class: Axis
Returns the extra length of the axes in cases where additional padding is needed

Overrides:
axisExtendedLength in class Axis
Returns:

TPTP 4.5.0 Platform Project
Internal API Specification