Package hec.geometry

Class AxisProp

java.lang.Object

hec.geometry.AxisProp

All Implemented Interfaces:

ScaleProperties, AsciiSerializable, FieldAccessor, Serializable

public class AxisProp
extends Object
implements ScaleProperties, AsciiSerializable

properties for Axis objects.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
double	actmax
double	actmin
boolean	autocomputeMajorTics
boolean	autocomputeMinorTics
boolean	automax
boolean	automin
boolean	autoviewmax
boolean	autoviewmin
boolean	canSwapAxis
static final boolean	DEFAULT_IS_REVERSED
boolean	isDefaultLimits	boolean that states if min/max are defaults or real limits
boolean	isReversed	Reverse direction of world coord relative to local coord
String	label
double	majortic	major tic intervals
double	max	maximum limit of the axis
double	min	minimum limit of the axis
double	minortic	minor tic intervals
String	name
int	numTicLabelLayers	max number of tic label layers.
boolean	rateData
double[][]	ratingFunction
boolean	swapAxis
int	type	axis type identifier

Constructor Summary

Constructors

Constructor	Description
AxisProp()	Default Constructor
AxisProp(AxisProp dp)	Copy Constructor

Method Summary

Modifier and Type	Method	Description
boolean	canSwapXYAxis()
double	getActualMaxScaleValue()	Returns the current maximum scale value of the current view.
double	getActualMinScaleValue()	Returns the current min scale value.
Object	getClone()
Object	getFieldObject(Field fld)	This method allows access to java.lang.reflect.Field objects within the implementing class.
double	getMajorTicInterval()	Returns the interval between the minor tics
double	getMaxScaleValue()	Gets the maximum value for an axis scale.
double	getMinorTicInterval()	Retruns the interval between the major tics
double	getMinScaleValue()	Gets the minimum value for an Axis Scale.
int	getNumTicLevels()
boolean	isAutoComputeMajorTics()
boolean	isAutoComputeMinorTics()
boolean	isAutomaticMax()
boolean	isAutomaticMin()
boolean	isAutomaticViewMax()
boolean	isAutomaticViewMin()
boolean	isReversed()
void	readProperties(BufferedReader in, String endTag)
void	readRatingFunction(BufferedReader reader, String line)
void	set(AxisProp dp)
void	setActualMaxScaleValue(double val)
void	setActualMinScaleValue(double val)
void	setAutoComputeMajorTics(boolean m)
void	setAutoComputeMinorTics(boolean m)
void	setAutomaticMax(boolean m)
void	setAutomaticMin(boolean m)
void	setAutomaticViewMax(boolean m)
void	setAutomaticViewMin(boolean m)
boolean	setFieldObject(Field fld, Object fobj)	This allows access to fields withing the implementing object to set there data.
void	setMajorTicInterval(double interval)	Sets the spacing between the minor tics
void	setMaxScaleValue(double val)
void	setMinorTicInterval(double interval)	Sets the spacing between each of the Major Tics
void	setMinScaleValue(double val)	Sets the new minimum scale value for an axis.
void	setNumTicLevels(int level)
void	setReversed(boolean m)
void	setSwapXYAxis(boolean b)
boolean	swapXYAxis()
void	writeProperties(BufferedWriter writer, String endTag)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_IS_REVERSED

public static final boolean DEFAULT_IS_REVERSED

See Also:

• Constant Field Values

name

public String name

label

public String label

isDefaultLimits

public boolean isDefaultLimits

boolean that states if min/max are defaults or real limits

min

public double min

minimum limit of the axis

max

public double max

maximum limit of the axis

isReversed

public boolean isReversed

Reverse direction of world coord relative to local coord

majortic

public double majortic

major tic intervals

minortic

public double minortic

minor tic intervals

type

public int type

axis type identifier

numTicLabelLayers

public int numTicLabelLayers

max number of tic label layers. -1 is unrestricted. Most important for time series axis.

actmax

public double actmax

actmin

public double actmin

automax

public boolean automax

automin

public boolean automin

autoviewmax

public boolean autoviewmax

autoviewmin

public boolean autoviewmin

autocomputeMajorTics

public boolean autocomputeMajorTics

autocomputeMinorTics

public boolean autocomputeMinorTics

ratingFunction

public double[][] ratingFunction

rateData

public boolean rateData

swapAxis

public boolean swapAxis

canSwapAxis

public boolean canSwapAxis

Constructor Details

AxisProp

public AxisProp()

Default Constructor

AxisProp

public AxisProp(AxisProp dp)

Copy Constructor

Method Details

canSwapXYAxis

public boolean canSwapXYAxis()

Specified by:

canSwapXYAxis in interface ScaleProperties

swapXYAxis

public boolean swapXYAxis()

Specified by:

swapXYAxis in interface ScaleProperties

setSwapXYAxis

public void setSwapXYAxis(boolean b)

Specified by:

setSwapXYAxis in interface ScaleProperties

writeProperties

public void writeProperties(BufferedWriter writer,
 String endTag)

readProperties

public void readProperties(BufferedReader in,
 String endTag)

readRatingFunction

public void readRatingFunction(BufferedReader reader,
 String line)

getClone

public Object getClone()

set

public void set(AxisProp dp)

getMajorTicInterval

public double getMajorTicInterval()

Description copied from interface: ScaleProperties

Returns the interval between the minor tics

Specified by:

getMajorTicInterval in interface ScaleProperties

getMaxScaleValue

public double getMaxScaleValue()

Description copied from interface: ScaleProperties

Gets the maximum value for an axis scale. The axis is bounded on the top by the maximum scale value

Specified by:

getMaxScaleValue in interface ScaleProperties

getMinScaleValue

public double getMinScaleValue()

Description copied from interface: ScaleProperties

Gets the minimum value for an Axis Scale. The scale for an axis is bounded on the bottom by the minimum scale value

Specified by:

getMinScaleValue in interface ScaleProperties

See Also:

• ScaleProperties.getMaxScaleValue()

getMinorTicInterval

public double getMinorTicInterval()

Description copied from interface: ScaleProperties

Retruns the interval between the major tics

Specified by:

getMinorTicInterval in interface ScaleProperties

setMajorTicInterval

public void setMajorTicInterval(double interval)

Description copied from interface: ScaleProperties

Sets the spacing between the minor tics

Specified by:

setMajorTicInterval in interface ScaleProperties

Parameters:

interval - The spacing to use between minor tics

setMaxScaleValue

public void setMaxScaleValue(double val)

Specified by:

setMaxScaleValue in interface ScaleProperties

setMinScaleValue

public void setMinScaleValue(double val)

Description copied from interface: ScaleProperties

Sets the new minimum scale value for an axis. This either limits or extends the minimum value for the axis

Specified by:

setMinScaleValue in interface ScaleProperties

setMinorTicInterval

public void setMinorTicInterval(double interval)

Description copied from interface: ScaleProperties

Sets the spacing between each of the Major Tics

Specified by:

setMinorTicInterval in interface ScaleProperties

Parameters:

interval - the interval to use for the major tics

setActualMaxScaleValue

public void setActualMaxScaleValue(double val)

Specified by:

setActualMaxScaleValue in interface ScaleProperties

setActualMinScaleValue

public void setActualMinScaleValue(double val)

Specified by:

setActualMinScaleValue in interface ScaleProperties

getActualMinScaleValue

public double getActualMinScaleValue()

Description copied from interface: ScaleProperties

Returns the current min scale value. This value represents the mininum value of the current view. This value must be greater than the minimum scale value

Specified by:

getActualMinScaleValue in interface ScaleProperties

getActualMaxScaleValue

public double getActualMaxScaleValue()

Description copied from interface: ScaleProperties

Returns the current maximum scale value of the current view. This number must be less than the maximum scale value and greater than the Actual Min Scale value.

Specified by:

getActualMaxScaleValue in interface ScaleProperties

isAutomaticMin

public boolean isAutomaticMin()

Specified by:

isAutomaticMin in interface ScaleProperties

isAutomaticMax

public boolean isAutomaticMax()

Specified by:

isAutomaticMax in interface ScaleProperties

setAutomaticMin

public void setAutomaticMin(boolean m)

Specified by:

setAutomaticMin in interface ScaleProperties

setAutomaticMax

public void setAutomaticMax(boolean m)

Specified by:

setAutomaticMax in interface ScaleProperties

isAutomaticViewMax

public boolean isAutomaticViewMax()

Specified by:

isAutomaticViewMax in interface ScaleProperties

isAutomaticViewMin

public boolean isAutomaticViewMin()

Specified by:

isAutomaticViewMin in interface ScaleProperties

setAutomaticViewMax

public void setAutomaticViewMax(boolean m)

Specified by:

setAutomaticViewMax in interface ScaleProperties

setAutomaticViewMin

public void setAutomaticViewMin(boolean m)

Specified by:

setAutomaticViewMin in interface ScaleProperties

isReversed

public boolean isReversed()

Specified by:

isReversed in interface ScaleProperties

setReversed

public void setReversed(boolean m)

Specified by:

setReversed in interface ScaleProperties

isAutoComputeMajorTics

public boolean isAutoComputeMajorTics()

Specified by:

isAutoComputeMajorTics in interface ScaleProperties

isAutoComputeMinorTics

public boolean isAutoComputeMinorTics()

Specified by:

isAutoComputeMinorTics in interface ScaleProperties

setAutoComputeMajorTics

public void setAutoComputeMajorTics(boolean m)

Specified by:

setAutoComputeMajorTics in interface ScaleProperties

setAutoComputeMinorTics

public void setAutoComputeMinorTics(boolean m)

Specified by:

setAutoComputeMinorTics in interface ScaleProperties

getNumTicLevels

public int getNumTicLevels()

Specified by:

getNumTicLevels in interface ScaleProperties

setNumTicLevels

public void setNumTicLevels(int level)

Specified by:

setNumTicLevels in interface ScaleProperties

getFieldObject

public Object getFieldObject(Field fld)

Description copied from interface: FieldAccessor

This method allows access to java.lang.reflect.Field objects within the implementing class.

Specified by:

getFieldObject in interface FieldAccessor

Parameters:

fld - The field to get.

Returns:

The data object that is stored in the given field

setFieldObject

public boolean setFieldObject(Field fld,
 Object fobj)

Description copied from interface: FieldAccessor

This allows access to fields withing the implementing object to set there data.

Specified by:

setFieldObject in interface FieldAccessor

Parameters:

fld - The java field object representing the member field to be set

fobj - The data to set in that field

Returns:

returns true if successful