Package org.eclipse.nebula.visualization.xygraph.linearscale

Class LinearScale

java.lang.Object

org.eclipse.draw2d.Figure

org.eclipse.nebula.visualization.xygraph.linearscale.AbstractScale

org.eclipse.nebula.visualization.xygraph.linearscale.LinearScale

All Implemented Interfaces:

IScaleProvider

Direct Known Subclasses:

Axis

public class LinearScale
extends AbstractScale
implements IScaleProvider

Linear(straight) scale has the tick labels and tick marks on a straight line. It can be used for any scale based widget, such as 2D plot, chart, graph, thermometer or tank etc.
A scale is comprised of Margins, Scale line, tick labels and tick marks which include minor ticks and major ticks.
Margin is half of the label's length(Horizontal Scale) or height(Vertical scale), so that the label can be displayed correctly. So the range must be set before you can get the correct margin.

|Margin|______|______|______|______|______|______|Margin|

Author:

Xihui Chen, Baha El-Kassaby, Peter Chang: Diamond Light Source contribution

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LinearScale.Orientation	scale direction

Nested classes/interfaces inherited from class org.eclipse.nebula.visualization.xygraph.linearscale.AbstractScale

AbstractScale.LabelSide

Nested classes/interfaces inherited from class org.eclipse.draw2d.Figure

org.eclipse.draw2d.Figure.FigureIterator

Nested classes/interfaces inherited from interface org.eclipse.draw2d.IFigure

org.eclipse.draw2d.IFigure.NoInsets

Field Summary

Fields inherited from class org.eclipse.nebula.visualization.xygraph.linearscale.AbstractScale

DEFAULT_ENGINEERING_FORMAT, DEFAULT_LOG_SCALE_MAX, DEFAULT_MAX, DEFAULT_MIN

Fields inherited from interface org.eclipse.draw2d.IFigure

MAX_DIMENSION, MIN_DIMENSION, NO_INSETS

Constructor Summary

Constructors

Constructor	Description
LinearScale()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	figureLayout()	Simple call of org.eclipse.draw2d.Figure.layout()
org.eclipse.draw2d.geometry.Dimension	getDimension(java.lang.Object obj)	Calculate dimension of a textual form of object
double	getLabel(double value)	Override to provide custom axis labels.
int	getLength()
Range	getLocalRange()
int	getMargin()	Margin is half of the label's length(Horizontal Scale) or height(Vertical scale), so that the label can be displayed correctly.
int	getMargin(boolean updateTick)	If updateTick is True, getMargin() is used where the tick are updated, if not, the method returns margin.
LinearScale.Orientation	getOrientation()
double	getPositionValue(double position, boolean relative)	Get the corresponding value on the position of the scale.
double	getPositionValue(int position, boolean relative)	Get the corresponding value on the position of the scale.
org.eclipse.draw2d.geometry.Dimension	getPreferredSize(int wHint, int hHint)
Range	getScaleRange()
LinearScaleTickLabels	getScaleTickLabels()	Gets the scale tick labels.
LinearScaleTickMarks	getScaleTickMarks()	Gets the scale tick marks.
int	getTickLength()
ITicksProvider	getTicksProvider()	Gets the ticks provider
int	getValuePosition(double value, boolean relative)	Get the position of the value based on scale.
double	getValuePrecisePosition(double value, boolean relative)	Get the position of the value based on scale.
boolean	hasTicksAtEnds()
boolean	isHorizontal()
boolean	isLabelCustomised()
boolean	isPrimary()
boolean	isShowMaxLabel()	shows the maximum value of the range as a label
boolean	isShowMinLabel()	shows the minimum value of the range as a label
void	setBounds(org.eclipse.draw2d.geometry.Rectangle rect)
void	setFont(org.eclipse.swt.graphics.Font font)
void	setForegroundColor(org.eclipse.swt.graphics.Color color)
void	setLength(int length)
void	setLocalRange(Range localRange)
void	setMargin(int margin)
void	setOrientation(LinearScale.Orientation orientation)	sets the orientation
void	setShowMaxLabel(boolean b)	sets the visibility of the maximum label
void	setShowMinLabel(boolean b)	sets the visibility of the minimum label
void	updateTick()	Updates the tick, recalculate all parameters, such as margin, length...

Methods inherited from class org.eclipse.nebula.visualization.xygraph.linearscale.AbstractScale

format, format, getFormatPattern, getMajorGridStep, getMajorTickMarkStepHint, getMinorTickMarkStepHint, getRange, getTickLabelSide, getTickLablesSide, getTimeUnit, isAutoFormat, isDateEnabled, isDirty, isLogScaleEnabled, isMinorTicksVisible, isScaleLineVisible, setAutoFormat, setDateEnabled, setFormatPattern, setLogScale, setMajorGridStep, setMajorTickMarkStepHint, setMinorTickMarkStepHint, setMinorTicksVisible, setRange, setRange, setRange, setScaleLineVisible, setTickLabelSide, setTickLableSide, setTimeUnit

Methods inherited from class org.eclipse.draw2d.Figure

add, add, add, add, addAncestorListener, addCoordinateListener, addFigureListener, addFocusListener, addKeyListener, addLayoutListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, containsPoint, containsPoint, erase, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, getBackgroundColor, getBorder, getBounds, getChildren, getClientArea, getClientArea, getClippingStrategy, getCursor, getFont, getForegroundColor, getInsets, getLayoutManager, getLocalBackgroundColor, getLocalForegroundColor, getLocation, getMaximumSize, getMinimumSize, getMinimumSize, getParent, getPreferredSize, getSize, getToolTip, getUpdateManager, handleFocusGained, handleFocusLost, handleKeyPressed, handleKeyReleased, handleMouseDoubleClicked, handleMouseDragged, handleMouseEntered, handleMouseExited, handleMouseHover, handleMouseMoved, handleMousePressed, handleMouseReleased, hasFocus, internalGetEventDispatcher, intersects, invalidate, invalidateTree, isCoordinateSystem, isEnabled, isFocusTraversable, isMirrored, isOpaque, isRequestFocusEnabled, isShowing, isVisible, paint, remove, removeAll, removeAncestorListener, removeCoordinateListener, removeFigureListener, removeFocusListener, removeKeyListener, removeLayoutListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setClippingStrategy, setConstraint, setCursor, setEnabled, setFocusTraversable, setLayoutManager, setLocation, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setValid, setVisible, translate, translateFromParent, translateToAbsolute, translateToParent, translateToRelative, validate

Methods inherited from interface org.eclipse.nebula.visualization.xygraph.linearscale.IScaleProvider

format, format, getFont, getForegroundColor, getMajorGridStep, getMajorTickMarkStepHint, getMinorTickMarkStepHint, getTimeUnit, isAutoFormat, isDateEnabled, isLogScaleEnabled, setAutoFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

LinearScale

public LinearScale()

Constructor.

Method Detail

getLength

public int getLength()

Specified by:

getLength in interface IScaleProvider

Returns:

the length of the whole scale (include margin)

setLength

public void setLength(int length)

Parameters:

length -

getMargin

public int getMargin(boolean updateTick)

If updateTick is True, getMargin() is used where the tick are updated, if not, the method returns margin.

Parameters:

updateTick -

Returns:

getMargin

public int getMargin()

Margin is half of the label's length(Horizontal Scale) or height(Vertical scale), so that the label can be displayed correctly. So the range and format pattern must be set correctly before you can get the correct margin.

Specified by:

getMargin in interface IScaleProvider

Returns:

the margin

setMargin

public void setMargin(int margin)

Parameters:

margin -

getOrientation

public LinearScale.Orientation getOrientation()

Returns:

the orientation

getPreferredSize

public org.eclipse.draw2d.geometry.Dimension getPreferredSize(int wHint,
                                                              int hHint)

Overrides:

getPreferredSize in class org.eclipse.draw2d.Figure

getTicksProvider

public ITicksProvider getTicksProvider()

Description copied from interface: IScaleProvider

Gets the ticks provider

Specified by:

getTicksProvider in interface IScaleProvider

Returns:

tick provider

getScaleTickLabels

public LinearScaleTickLabels getScaleTickLabels()

Gets the scale tick labels.

Returns:

the scale tick labels

getScaleTickMarks

public LinearScaleTickMarks getScaleTickMarks()

Gets the scale tick marks.

Returns:

the scale tick marks

getTickLength

public int getTickLength()

Returns:

the length of the tick part (without margin)

getValuePosition

public int getValuePosition(double value,
                            boolean relative)

Get the position of the value based on scale.

Parameters:

value - the value to find its position. Support value out of range.

relative - return the position relative to the left/bottom bound of the scale if true. If false, return the absolute position which has the scale bounds counted.

Returns:

position in pixels

getValuePrecisePosition

public double getValuePrecisePosition(double value,
                                      boolean relative)

Get the position of the value based on scale.

Parameters:

value - the value to find its position. Support value out of range.

relative - return the position relative to the left/bottom bound of the scale if true. If false, return the absolute position which has the scale bounds counted.

Returns:

position in pixels

getPositionValue

public double getPositionValue(int position,
                               boolean relative)

Get the corresponding value on the position of the scale.

Parameters:

the - position.

true - if the position is relative to the left/bottom bound of the scale; False if it is the absolute position.

Returns:

the value corresponding to the position.

getPositionValue

public double getPositionValue(double position,
                               boolean relative)

Get the corresponding value on the position of the scale.

Parameters:

the - position.

true - if the position is relative to the left/bottom bound of the scale; False if it is the absolute position.

Returns:

the value corresponding to the position.

isHorizontal

public boolean isHorizontal()

Specified by:

isHorizontal in interface IScaleProvider

Returns:

True if scale is horizontal

isShowMaxLabel

public boolean isShowMaxLabel()

shows the maximum value of the range as a label

Returns:

true (default) if shown

isShowMinLabel

public boolean isShowMinLabel()

shows the minimum value of the range as a label

Returns:

true (default) if shown

figureLayout

public void figureLayout()

Simple call of org.eclipse.draw2d.Figure.layout()

setBounds

public void setBounds(org.eclipse.draw2d.geometry.Rectangle rect)

Overrides:

setBounds in class org.eclipse.draw2d.Figure

setFont

public void setFont(org.eclipse.swt.graphics.Font font)

Overrides:

setFont in class AbstractScale

setForegroundColor

public void setForegroundColor(org.eclipse.swt.graphics.Color color)

Overrides:

setForegroundColor in class org.eclipse.draw2d.Figure

setOrientation

public void setOrientation(LinearScale.Orientation orientation)

sets the orientation

Parameters:

orientation - the orientation to set

setShowMaxLabel

public void setShowMaxLabel(boolean b)

sets the visibility of the maximum label

Parameters:

b - show maximal value as a label

setShowMinLabel

public void setShowMinLabel(boolean b)

sets the visibility of the minimum label

Parameters:

b - show minimum value as a label

getLocalRange

public Range getLocalRange()

Returns:

range used for axis (not range given by data)

setLocalRange

public void setLocalRange(Range localRange)

Parameters:

localRange -

updateTick

public void updateTick()

Updates the tick, recalculate all parameters, such as margin, length...

Specified by:

updateTick in class AbstractScale

getScaleRange

public Range getScaleRange()

Specified by:

getScaleRange in interface IScaleProvider

Returns:

scale range

getDimension

public org.eclipse.draw2d.geometry.Dimension getDimension(java.lang.Object obj)

Calculate dimension of a textual form of object

Specified by:

getDimension in interface IScaleProvider

Parameters:

obj - object

Returns:

dimension

isPrimary

public boolean isPrimary()

Specified by:

isPrimary in interface IScaleProvider

Returns:

true if axis is a primary one (i.e. left for y and bottom for x)

getLabel

public double getLabel(double value)

Override to provide custom axis labels.

Specified by:

getLabel in interface IScaleProvider

Returns:

double value of label

isLabelCustomised

public boolean isLabelCustomised()

Specified by:

isLabelCustomised in interface IScaleProvider

Returns:

true if axis labels are customised

hasTicksAtEnds

public boolean hasTicksAtEnds()

Specified by:

hasTicksAtEnds in interface IScaleProvider

Returns:

true if ticks at end of axis are shown