org.eclipse.nebula.visualization.xygraph.linearscale

Class LinearScaleTicks

java.lang.Object

org.eclipse.nebula.visualization.xygraph.linearscale.LinearScaleTicks

All Implemented Interfaces:

ITicksProvider

public class LinearScaleTicks
extends java.lang.Object
implements ITicksProvider

Default scale tick mark algorithm

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME The name of this tick provider

Constructor Summary

Constructors

Constructor and Description
LinearScaleTicks(IScaleProvider scale) constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultFormatPattern(double min, double max)
int	getGridStepInPixels()
int	getHeadMargin()
java.lang.String	getLabel(int index)
int	getLabelPosition(int index)
java.util.List<java.lang.String>	getLabels()
int	getMajorCount()
int	getMaxHeight()
int	getMaxWidth()
int	getMinorCount()
int	getMinorPosition(int index)
int	getPosition(int index)
java.util.List<java.lang.Integer>	getPositions() Gets the tick positions.
int	getTailMargin()
int	getTickLabelMaxHeight()
int	getTickLabelMaxLength()
double	getValue(int index)
java.util.List<java.lang.Boolean>	getVisibilities()
boolean	isShowMaxLabel() Shows the maximum value of the range as a label
boolean	isShowMinLabel() Shows the minimum value of the range as a label
boolean	isVisible(int index)
void	setShowMaxLabel(boolean showMaxLabel) sets the visibility of the maximum label
void	setShowMinLabel(boolean showMinLabel) Sets the visibility of the minimum label
Range	update(double min, double max, int length) Update ticks.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

The name of this tick provider

See Also:

Constant Field Values

Constructor Detail

LinearScaleTicks

public LinearScaleTicks(IScaleProvider scale)

constructor

Parameters:

scale -

Method Detail

getGridStepInPixels

public int getGridStepInPixels()

Returns:

the gridStepInPixel

getTickLabelMaxHeight

public int getTickLabelMaxHeight()

Returns:

the tickLabelMaxHeight

getTickLabelMaxLength

public int getTickLabelMaxLength()

Returns:

the tickLabelMaxLength

getPositions

public java.util.List<java.lang.Integer> getPositions()

Description copied from interface: ITicksProvider

Gets the tick positions.

Specified by:

getPositions in interface ITicksProvider

Returns:

the tick positions

getVisibilities

public java.util.List<java.lang.Boolean> getVisibilities()

Specified by:

getVisibilities in interface ITicksProvider

Returns:

the tick visibilities

getPosition

public int getPosition(int index)

Specified by:

getPosition in interface ITicksProvider

Returns:

tick position

getValue

public double getValue(int index)

Specified by:

getValue in interface ITicksProvider

Returns:

tick value

getLabel

public java.lang.String getLabel(int index)

Specified by:

getLabel in interface ITicksProvider

Returns:

tick label

getLabels

public java.util.List<java.lang.String> getLabels()

Specified by:

getLabels in interface ITicksProvider

Returns:

the tick labels

getLabelPosition

public int getLabelPosition(int index)

Specified by:

getLabelPosition in interface ITicksProvider

Returns:

label position

isVisible

public boolean isVisible(int index)

Specified by:

isVisible in interface ITicksProvider

Returns:

true if tick is visible

getMajorCount

public int getMajorCount()

Specified by:

getMajorCount in interface ITicksProvider

Returns:

number of major ticks

getMinorCount

public int getMinorCount()

Specified by:

getMinorCount in interface ITicksProvider

Returns:

number of minor ticks

getMinorPosition

public int getMinorPosition(int index)

Specified by:

getMinorPosition in interface ITicksProvider

Returns:

minor tick position

getMaxWidth

public int getMaxWidth()

Specified by:

getMaxWidth in interface ITicksProvider

Returns:

maximum width in pixels of tick labels

getMaxHeight

public int getMaxHeight()

Specified by:

getMaxHeight in interface ITicksProvider

Returns:

maximum height in pixels of tick labels

isShowMaxLabel

public boolean isShowMaxLabel()

Description copied from interface: ITicksProvider

Shows the maximum value of the range as a label

Specified by:

isShowMaxLabel in interface ITicksProvider

Returns:

true (default) if shown

setShowMaxLabel

public void setShowMaxLabel(boolean showMaxLabel)

Description copied from interface: ITicksProvider

sets the visibility of the maximum label

Specified by:

setShowMaxLabel in interface ITicksProvider

isShowMinLabel

public boolean isShowMinLabel()

Description copied from interface: ITicksProvider

Shows the minimum value of the range as a label

Specified by:

isShowMinLabel in interface ITicksProvider

Returns:

true (default) if shown

setShowMinLabel

public void setShowMinLabel(boolean showMinLabel)

Description copied from interface: ITicksProvider

Sets the visibility of the minimum label

Specified by:

setShowMinLabel in interface ITicksProvider

getDefaultFormatPattern

public java.lang.String getDefaultFormatPattern(double min,
                                                double max)

Specified by:

getDefaultFormatPattern in interface ITicksProvider

Returns:

default format pattern for labels

getHeadMargin

public int getHeadMargin()

Specified by:

getHeadMargin in interface ITicksProvider

Returns:

margin in pixel between edge of client area and head of axis line

getTailMargin

public int getTailMargin()

Specified by:

getTailMargin in interface ITicksProvider

Returns:

margin in pixel between edge of client area and tail of axis line

update

public Range update(double min,
                    double max,
                    int length)

Description copied from interface: ITicksProvider

Update ticks.

Specified by:

update in interface ITicksProvider

Returns:

null unless the provider has not had cause to change the range - in which case, the new range is returned.