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, ARRAY, AUTO, AVERAGE, AXIS, BACKWARD, BASE, BASE_AXIS, BELOW, BIG_NUMBER_PRIMITIVE_ARRAY, BOOLEAN, BOTTOM, CENTER, COLLECTION, DATE_TIME, DESIGN_TIME, EMPTY_STRING, EQUAL, FORWARD, HORIZONTAL, INSIDE, LABELS, LEFT, LEGEND_ENTRY, LEGEND_GROUP_NAME, 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, NUMBER_PRIMITIVE_ARRAY, 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)
           
ScaleContext(int iMarginPercent, int iType, java.lang.Object oMinAuto, java.lang.Object oMaxAuto, java.lang.Object oStep)
           
ScaleContext(int iMarginPercent, int iType, java.lang.Object oUnit, java.lang.Object oMinValue, java.lang.Object oMaxValue, java.lang.Object oStep)
           
 
Method Summary
 void computeMinMax()
           
 void computeMinMax(boolean bAlignZero)
           
 ScaleContext copy()
           
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()
           
 java.lang.Integer getStepNumber()
           
 java.lang.Object getUnit()
           
 boolean isExpandMinmax()
           
 void setExpandMinmax(boolean expandMinmax)
           
 void setFixedStep(boolean bStepFixed, java.lang.Integer oStepNumber)
           
 void setFixedValue(boolean bMinimumFixed, boolean bMaximumFixed, java.lang.Object oMinFixed, java.lang.Object oMaxFixed)
           
 void setMax(java.lang.Object oMax)
           
 void setMaxWithMargin(java.lang.Object oMaxAuto)
           
 void setMin(java.lang.Object oMin)
           
 void setMinWithMargin(java.lang.Object oMinAuto)
           
 void setStep(java.lang.Object oStep)
           
 void setStepNumber(java.lang.Integer oStepNumber)
           
 void setUnit(java.lang.Object oUnit)
           
 void updateShared(ScaleContext that)
           
 
Methods inherited from class org.eclipse.birt.chart.computation.Methods
asDateTime, asDouble, asInteger, computeBox, computeBox, computeBox, computeBox, computeFontHeight, computeHeight, computeHeight, computeLabelSize, computePolygon, computePolygon, computePolygon, computeRotatedTopPoint, computeWidth, computeWidth, getLabelPosition, getLocation, getLocation, getLocation, getNormalizedLocation, getNormalizedLocation
 
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)

ScaleContext

public ScaleContext(int iMarginPercent,
                    int iType,
                    java.lang.Object oUnit,
                    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

copy

public ScaleContext copy()

updateShared

public void updateShared(ScaleContext that)
Parameters:
that -

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

setMin

public void setMin(java.lang.Object oMin)

getMax

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

Returns:
the maximum of the scale

setMax

public void setMax(java.lang.Object oMax)

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.

setMinWithMargin

public void setMinWithMargin(java.lang.Object oMinAuto)

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.

setMaxWithMargin

public void setMaxWithMargin(java.lang.Object oMaxAuto)

getStep

public java.lang.Object getStep()

setStep

public void setStep(java.lang.Object oStep)

getStepNumber

public java.lang.Integer getStepNumber()

setStepNumber

public void setStepNumber(java.lang.Integer oStepNumber)

computeMinMax

public void computeMinMax()

computeMinMax

public void computeMinMax(boolean bAlignZero)

getUnit

public java.lang.Object getUnit()
Returns:
Returns the iUnit.

setUnit

public void setUnit(java.lang.Object oUnit)

isExpandMinmax

public boolean isExpandMinmax()
Returns:
Returns the bExpandMinmax.

setExpandMinmax

public void setExpandMinmax(boolean expandMinmax)
Parameters:
expandMinmax - The bExpandMinmax to set.


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