ucar.visad.display

Class LatLonLabels

java.lang.Object

ucar.visad.display.Displayable

ucar.visad.display.DisplayableData

ucar.visad.display.LineDrawing

ucar.visad.display.TextDisplayable

ucar.visad.display.LatLonLabels

public class LatLonLabels
extends TextDisplayable

Class for creating lat/lon labels

Nested Class Summary

Nested classes/interfaces inherited from class ucar.visad.display.DisplayableData

DisplayableData.DragAdapter

Field Summary

Fields inherited from class ucar.visad.display.LineDrawing

COLOR, LINE_STYLE, LINE_WIDTH, POINT_SIZE

Fields inherited from class ucar.visad.display.DisplayableData

MANIPULABLE, renderer, VISIBLE

Fields inherited from class ucar.visad.display.Displayable

DISPLAY, parent, SCALAR_MAP_SET

Constructor Summary

Constructors

Constructor and Description
LatLonLabels() Default ctor
LatLonLabels(LatLonLabels that) Copy constructor
LatLonLabels(visad.ScalarType textType) Create a LatLonLabels with the type for the values
LatLonLabels(java.lang.String name) Create a LatLonLabels with the name
LatLonLabels(java.lang.String name, visad.ScalarType textType) Create a default object
LatLonLabels(java.lang.String name, visad.ScalarType textType, boolean isLatitude, float increment, float min, float max, float base, float[] labelLines) Create LatLonLabels

Method Summary

Modifier and Type	Method and Description
protected void	createLabels() Generate the label field
float	getBase()
float	getInterval() Get the interval between labels (degrees)
java.lang.String	getLabelFormat() Get the label format
float[]	getLabelLines()
float	getMax()
float	getMin()
visad.ScalarType	getTextType() Return the currently used ScalarType for display.
boolean	getUse360() Get whether to use 0-360 labels for longitude
boolean	isLatitude()
void	setBase(float base)
void	setInterval(float interval) Set the interval between labels (degrees)
void	setLabelFormat(java.lang.String labelFormat) Set the interval between labels (degrees)
void	setLabelLines(float[] labelLines)
void	setLatitude(boolean isLatitude)
void	setMax(float max)
void	setMin(float min)
void	setTextType(visad.ScalarType textType) Set the text type to use.
void	setUse360(boolean yesorno) Set whether to use 0-360 labels for longitude
void	setValues(float increment, float min, float max, float base, float[] labelLines) Set the values for this LatLonLabels

Methods inherited from class ucar.visad.display.TextDisplayable

cloneForDisplay, getDataRenderer, getFont, getHersheyFont, getJustification, getNumberFormat, getScreenLocked, getSphere, getTextSize, getverticalJustification, setCharacterRotation, setDisplayUnit, setFont, setJustification, setNumberFormat, setRotation, setScreenLocked, setSphere, setTextSize, setVerticalJustification, setVisible

Methods inherited from class ucar.visad.display.LineDrawing

getColor, getLineStyle, getLineWidth, getPointSize, setColor, setHSV, setHSV, setLineStyle, setLineWidth, setPointSize, setRGB, setRGB, setRGBA, setRGBA

Methods inherited from class ucar.visad.display.DisplayableData

addAction, dataChange, destroy, getActive, getAnimationSet, getData, getName, hasData, hasDataObject, isManipulable, isPickable, myAddConstantMaps, myAddDataReferences, myRemoveDataReferences, removeAction, setActive, setData, setDataReference, setDragAdapter, setManipulable, setPickable, setPointMode, setUseFastRendering, showme, toString

Methods inherited from class ucar.visad.display.Displayable

addConstantMap, addConstantMaps, addDataReferences, addPropertyChangeListener, addPropertyChangeListener, addRefsInvoked, addScalarMap, addScalarMaps, applyColorUnit, applyDisplayUnit, checkUnit, combineConstantMaps, destroyDisplayable, firePropertyChange, firePropertyChange, fireScalarMapSetChange, getColorUnit, getConstantMaps, getDestroyed, getDisplay, getDisplayMaster, getDisplayUnit, getPointMode, getScalarMap, getScalarMap, getScalarMap, getScalarMapSet, getUseFastRendering, getUseTimesInAnimation, getVisible, isActive, isUnitCompatible, isVisible, logException, removeConstantMap, removeDataReferences, removePropertyChangeListener, removePropertyChangeListener, removeScalarMap, replaceScalarMap, setAdjustFlow, setColorPalette, setColorPalette, setColorUnit, setConstantPosition, setContourInfo, setDisplay, setDisplayActive, setDisplayInactive, setDisplayMaster, setOverrideAnimationSet, setOverrideAnimationSet, setParent, setRangeForColor, setRangeForColor, setScalarMapSet, setSelectedRange, setSelectedRange, setUseTimesInAnimation, toFront

Methods inherited from class java.lang.Object

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

Constructor Detail

LatLonLabels

public LatLonLabels()
             throws visad.VisADException,
                    java.rmi.RemoteException

Default ctor

Throws:

java.rmi.RemoteException - Java RMI problem

visad.VisADException - Unable to create VisAD object

LatLonLabels

public LatLonLabels(java.lang.String name)
             throws visad.VisADException,
                    java.rmi.RemoteException

Create a LatLonLabels with the name

Parameters:

name - the name for the DataReference

Throws:

java.rmi.RemoteException - Java RMI problem

visad.VisADException - Unable to create VisAD object

LatLonLabels

public LatLonLabels(visad.ScalarType textType)
             throws visad.VisADException,
                    java.rmi.RemoteException

Create a LatLonLabels with the type for the values

Parameters:

textType - the type for the text

Throws:

java.rmi.RemoteException - Java RMI problem

visad.VisADException - Unable to create VisAD object

LatLonLabels

public LatLonLabels(java.lang.String name,
                    visad.ScalarType textType)
             throws visad.VisADException,
                    java.rmi.RemoteException

Create a default object

Parameters:

name - the name for the DataReference

textType - the type for the values

Throws:

java.rmi.RemoteException - Java RMI problem

visad.VisADException - Unable to create VisAD object

LatLonLabels

public LatLonLabels(java.lang.String name,
                    visad.ScalarType textType,
                    boolean isLatitude,
                    float increment,
                    float min,
                    float max,
                    float base,
                    float[] labelLines)
             throws visad.VisADException,
                    java.rmi.RemoteException

Create LatLonLabels

Parameters:

name - the name for the DataReference

textType - the type for the values

isLatitude - true if is latitude

increment - the increment

min - the minimum value

max - the maximum value

base - the base value

labelLines - the lines to label

Throws:

java.rmi.RemoteException - Java RMI problem

visad.VisADException - Unable to create VisAD object

LatLonLabels

public LatLonLabels(LatLonLabels that)
             throws java.rmi.RemoteException,
                    visad.VisADException

Copy constructor

Parameters:

that - the other LatLonLabels

Throws:

java.rmi.RemoteException - Java RMI problem

visad.VisADException - Problem creating VisAD object

Method Detail

setValues

public void setValues(float increment,
                      float min,
                      float max,
                      float base,
                      float[] labelLines)
               throws visad.VisADException,
                      java.rmi.RemoteException

Set the values for this LatLonLabels

Parameters:

increment - the increment

base - the base

max - the maximum value

min - the minimum value

labelLines - the label locations

Throws:

java.rmi.RemoteException - Java RMI problem

visad.VisADException - Unable to create VisAD object

getTextType

public visad.ScalarType getTextType()

Return the currently used ScalarType for display.

Overrides:

getTextType in class TextDisplayable

Returns:

the ScalarType

setTextType

public void setTextType(visad.ScalarType textType)
                 throws java.rmi.RemoteException,
                        visad.VisADException

Set the text type to use.

Overrides:

setTextType in class TextDisplayable

Parameters:

textType - RealType or TextType to map to Display.Text

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

createLabels

protected void createLabels()
                     throws visad.VisADException,
                            java.rmi.RemoteException

Generate the label field

Throws:

java.rmi.RemoteException - Java RMI problem

visad.VisADException - Unable to create VisAD object

isLatitude

public boolean isLatitude()

Returns:

the isLatitude

setLatitude

public void setLatitude(boolean isLatitude)
                 throws visad.VisADException,
                        java.rmi.RemoteException

Parameters:

isLatitude - the isLatitude to set

Throws:

java.rmi.RemoteException - Java RMI Exception

visad.VisADException - problem creating labels

getBase

public float getBase()

Returns:

the base

setBase

public void setBase(float base)
             throws visad.VisADException,
                    java.rmi.RemoteException

Parameters:

base - the base to set

Throws:

java.rmi.RemoteException - Java RMI Exception

visad.VisADException - problem creating labels

getMax

public float getMax()

Returns:

the max

setMax

public void setMax(float max)
            throws visad.VisADException,
                   java.rmi.RemoteException

Parameters:

max - the max to set

Throws:

java.rmi.RemoteException - Java RMI Exception

visad.VisADException - problem creating labels

getMin

public float getMin()

Returns:

the min

setMin

public void setMin(float min)
            throws visad.VisADException,
                   java.rmi.RemoteException

Parameters:

min - the min to set

Throws:

java.rmi.RemoteException - Java RMI Exception

visad.VisADException - problem creating labels

getInterval

public float getInterval()

Get the interval between labels (degrees)

Returns:

the increment

setInterval

public void setInterval(float interval)
                 throws visad.VisADException,
                        java.rmi.RemoteException

Set the interval between labels (degrees)

Parameters:

interval - the interval to set

Throws:

java.rmi.RemoteException - Java RMI Exception

visad.VisADException - problem creating labels

getUse360

public boolean getUse360()

Get whether to use 0-360 labels for longitude

Returns:

true if using 0-360

setUse360

public void setUse360(boolean yesorno)
               throws visad.VisADException,
                      java.rmi.RemoteException

Set whether to use 0-360 labels for longitude

Parameters:

yesorno - true to use 0-360 labels for longitude

Throws:

java.rmi.RemoteException - Java RMI Exception

visad.VisADException - problem creating labels

getLabelFormat

public java.lang.String getLabelFormat()

Get the label format

Returns:

the increment

setLabelFormat

public void setLabelFormat(java.lang.String labelFormat)
                    throws visad.VisADException,
                           java.rmi.RemoteException

Set the interval between labels (degrees)

Parameters:

labelFormat - the label format

Throws:

java.rmi.RemoteException - Java RMI Exception

visad.VisADException - problem creating labels

getLabelLines

public float[] getLabelLines()

Returns:

the labelLines

setLabelLines

public void setLabelLines(float[] labelLines)
                   throws visad.VisADException,
                          java.rmi.RemoteException

Parameters:

labelLines - the labelLines to set

Throws:

java.rmi.RemoteException - Java RMI Exception

visad.VisADException - problem creating labels