ucar.visad.display
Class RingLabels

java.lang.Object
  ucar.visad.display.Displayable
      ucar.visad.display.DisplayableData
          ucar.visad.display.LineDrawing
              ucar.visad.display.TextDisplayable
                  ucar.visad.display.RingLabels

public class RingLabels
extends TextDisplayable

Labels for RingSets

Version:

$Revision: 1.6 $

Author:

IDV Development Team

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, VISIBLE

Fields inherited from class ucar.visad.display.Displayable

DISPLAY, parent, SCALAR_MAP_SET

Constructor Summary

RingLabels(String name, RealTupleType polarType, Color color)
Use a specific RingSet to define the labels.

RingLabels(String name, RealTupleType polarType, Real bearing, Color color)
Construct a set of RingLabels

Method Summary

Unit	getLabelUnit() Get the label unit.
void	setLabelPosition(Real bearing) Set the position of the labels along the bearing (azimuth)
void	setLabelUnit(Unit unit) Set the label units
void	setLabelValues(float[] values) Set the label values from the array.
void	setLabelValues(float[] values, Unit units) Set the label values from the array.
void	setLabelValues(Gridded1DSet labelValues) Set the label values
void	setLabelValues(Real rangeInc, Real rangeMax) Set the label values base on the increment and maximum value

Methods inherited from class ucar.visad.display.TextDisplayable

cloneForDisplay, getDataRenderer, getFont, getHersheyFont, getJustification, getNumberFormat, getScreenLocked, getTextSize, getTextType, getverticalJustification, setCharacterRotation, setDisplayUnit, setFont, setJustification, setNumberFormat, setRotation, setScreenLocked, setTextSize, setTextType, setVerticalJustification

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, setManipulable, setPickable, setPointMode, setUseFastRendering, setVisible, toString

Methods inherited from class ucar.visad.display.Displayable

addConstantMap, addConstantMaps, addDataReferences, addPropertyChangeListener, addPropertyChangeListener, addRefsInvoked, addScalarMap, addScalarMaps, applyColorUnit, applyDisplayUnit, checkUnit, combineConstantMaps, firePropertyChange, firePropertyChange, fireScalarMapSetChange, getColorUnit, getConstantMaps, 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

RingLabels

public RingLabels(String name,
                  RealTupleType polarType,
                  Color color)
           throws RemoteException,
                  VisADException

Use a specific RingSet to define the labels. Each line in the RingSet will be labeled.

Parameters:

name - name of this object

polarType - type for the polar transform

color - Color for the ring set

Throws:

RemoteException - Java RMI error

VisADException - problem creating VisAD object

RingLabels

public RingLabels(String name,
                  RealTupleType polarType,
                  Real bearing,
                  Color color)
           throws RemoteException,
                  VisADException

Construct a set of RingLabels

Parameters:

name - name of this object

polarType - type for the polar transform

bearing - bearing to put the labels

color - Color for the ring set

Throws:

RemoteException - Java RMI error

VisADException - problem creating VisAD object

Method Detail

setLabelUnit

public void setLabelUnit(Unit unit)
                  throws VisADException,
                         RemoteException

Set the label units

Parameters:

unit - unit for the labels

Throws:

RemoteException - Java RMI error

VisADException - problem creating VisAD object

getLabelUnit

public Unit getLabelUnit()

Get the label unit.

Returns:

label unit

setLabelValues

public void setLabelValues(Gridded1DSet labelValues)
                    throws VisADException,
                           RemoteException

Set the label values

Parameters:

labelValues - values in a Gridded1DSet

Throws:

RemoteException - Java RMI error

VisADException - problem creating VisAD object

setLabelValues

public void setLabelValues(float[] values)
                    throws VisADException,
                           RemoteException

Set the label values from the array. Use label type to construct the set.

Parameters:

values - array of label values

Throws:

RemoteException - Java RMI error

VisADException - problem creating VisAD object

setLabelValues

public void setLabelValues(float[] values,
                           Unit units)
                    throws VisADException,
                           RemoteException

Set the label values from the array. Use label type to construct the set.

Parameters:

values - label values

units - unit for the labels.

Throws:

RemoteException - Java RMI error

VisADException - problem creating VisAD object

setLabelValues

public void setLabelValues(Real rangeInc,
                           Real rangeMax)
                    throws VisADException,
                           RemoteException

Set the label values base on the increment and maximum value

Parameters:

rangeInc - increment between labels

rangeMax - maximum label value

Throws:

RemoteException - Java RMI error

VisADException - problem creating VisAD object

setLabelPosition

public void setLabelPosition(Real bearing)
                      throws VisADException,
                             RemoteException

Set the position of the labels along the bearing (azimuth)

Parameters:

bearing - azimuth value

Throws:

RemoteException - Java RMI error

VisADException - problem creating VisAD object