org.eclipse.birt.chart.computation.withaxes
Class ScaleContext

java.lang.Object
  extended by org.eclipse.birt.chart.computation.Methods
      extended by org.eclipse.birt.chart.computation.withaxes.ScaleContext
All Implemented Interfaces:
IConstants

public class ScaleContext
extends Methods

Scale context for min/max computation.


Field Summary
 
Fields inherited from interface org.eclipse.birt.chart.computation.IConstants
ABOVE, ANCILLARY_AXIS, ANCILLARY_BASE, AUTO, AVERAGE, AXIS, BACKWARD, BASE, BASE_AXIS, BELOW, BOTTOM, CENTER, COLLECTION, DATE_TIME, DESIGN_TIME, EMPTY_STRING, EQUAL, FORWARD, HORIZONTAL, INSIDE, LABELS, LEFT, LEGEND_ENTRY, LEGEND_MINSLICE_ENTRY, LEGEND_SEPERATOR, LESS, LINE_EXPAND_DOUBLE_SIZE, LINE_EXPAND_SIZE, LINEAR, LOG_10, LOGARITHMIC, MAJOR, MAX, MIN, MINOR, MORE, NON_PRIMITIVE_ARRAY, NULL_STRING, NUMERICAL, ONE_SPACE, ORTHOGONAL, ORTHOGONAL_AXIS, OTHER, OUTSIDE, PERCENT, POSITION_MASK, POSITION_MOVE_ABOVE, POSITION_MOVE_BELOW, POSITION_MOVE_LEFT, POSITION_MOVE_RIGHT, PRIMITIVE_ARRAY, RIGHT, RUN_TIME, SOME_NULL, TEXT, THREE_D, TICK_ABOVE, TICK_ACROSS, TICK_BELOW, TICK_LEFT, TICK_NONE, TICK_RIGHT, TICK_SIDE1, TICK_SIDE2, TICK_SIZE, TOP, TWO_5_D, TWO_D, UNDEFINED, UNDEFINED_STRING, USER_INTERFACE, VALUE, VERTICAL
 
Constructor Summary
ScaleContext(int iMarginPercent, int iType, int iUnit, java.lang.Object oMinValue, java.lang.Object oMaxValue, java.lang.Object oStep)
           
ScaleContext(int iMarginPercent, int iType, java.lang.Object oMinAuto, java.lang.Object oMaxAuto, java.lang.Object oStep)
           
 
Method Summary
 void computeMinMax()
           
static ScaleContext createSimpleScale(java.lang.Object oMin, java.lang.Object oMax)
          Creates a simple instance of scale.
 java.lang.Object getMax()
          Returns the maximum of the scale
 java.lang.Object getMaxWithMargin()
          Returns the maximum plus margin.
 java.lang.Object getMin()
          Returns the minimum of the scale
 java.lang.Object getMinWithMargin()
          Returns the minimum plus margin.
 java.lang.Object getStep()
           
 boolean isShared()
          Returns if the scale will be shared among multiple chart instances
 void setFixedStep(boolean bStepFixed, java.lang.Integer oStepNumber)
           
 void setFixedValue(boolean bMinimumFixed, boolean bMaximumFixed, java.lang.Object oMinFixed, java.lang.Object oMaxFixed)
           
 void setShared(boolean bShared)
          Marks the scale will be shared among multiple chart instances or not
 
Methods inherited from class org.eclipse.birt.chart.computation.Methods
asDateTime, asDouble, asInteger, computeBox, computeBox, computeHeight, computePolygon, computeRotatedTopPoint, computeWidth, getLabelPosition, getLocation, getLocation, getLocation, getNormalizedLocation, getNormalizedLocation, limitDataPointLabelLocation
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ScaleContext

public ScaleContext(int iMarginPercent,
                    int iType,
                    int iUnit,
                    java.lang.Object oMinValue,
                    java.lang.Object oMaxValue,
                    java.lang.Object oStep)

ScaleContext

public ScaleContext(int iMarginPercent,
                    int iType,
                    java.lang.Object oMinAuto,
                    java.lang.Object oMaxAuto,
                    java.lang.Object oStep)
Method Detail

createSimpleScale

public static ScaleContext createSimpleScale(java.lang.Object oMin,
                                             java.lang.Object oMax)
Creates a simple instance of scale. Note that this instance is just used to store min/max and can not be computed directly.

Parameters:
oMin -
oMax -
Since:
2.3

setFixedValue

public void setFixedValue(boolean bMinimumFixed,
                          boolean bMaximumFixed,
                          java.lang.Object oMinFixed,
                          java.lang.Object oMaxFixed)

setFixedStep

public void setFixedStep(boolean bStepFixed,
                         java.lang.Integer oStepNumber)

getMin

public java.lang.Object getMin()
Returns the minimum of the scale

Returns:
the minimum of the scale

getMax

public java.lang.Object getMax()
Returns the maximum of the scale

Returns:
the maximum of the scale

getMinWithMargin

public java.lang.Object getMinWithMargin()
Returns the minimum plus margin. Margin means extra space for rendering and clipping. If margin is 0, or no margin needed, return null.

Returns:
the minimum plus margin. If no margin, return null.

getMaxWithMargin

public java.lang.Object getMaxWithMargin()
Returns the maximum plus margin. Margin means extra space for rendering and clipping. If margin is 0, or no margin needed, return null.

Returns:
the maximum plus margin. If no margin, return null.

getStep

public java.lang.Object getStep()

computeMinMax

public void computeMinMax()

setShared

public void setShared(boolean bShared)
Marks the scale will be shared among multiple chart instances or not

Parameters:
bShared - shared or not
Since:
2.3

isShared

public boolean isShared()
Returns if the scale will be shared among multiple chart instances

Returns:
shared or not
Since:
2.3


Copyright © 2005-2008 Actuate Corp. All rights reserved.