visad
Class Control

java.lang.Object
  extended by visad.Control
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
AnimationSetControl, AVControlJ2D, AVControlJ3D, BaseColorControl, ContourControl, FlowControl, GraphicsModeControl, ProjectionControl, RangeControl, RendererControl, ShapeControl, TextControl, ToggleControl

public abstract class Control
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Control is the VisAD superclass for controls for DisplayRealTypes.

See Also:
Serialized Form

Constructor Summary
Control(DisplayImpl d)
           
 
Method Summary
 void addControlListener(ControlListener listener)
          add a ControlListener
 void animation_string(RealType real, Set set, double value, int current)
          used by java3d.AnimationControlJ3D and java2d.AnimationControlJ2D
 void changeControl(boolean tick)
          invoked every time values of this Control change; tick is true to notify the Display
 boolean checkTicks(DataRenderer r, DataDisplayLink link)
          return true if Control changed and requires re-Transform
 java.lang.Object clone()
           
 boolean equals(java.lang.Object o)
           
 DisplayImpl getDisplay()
           
 DisplayRenderer getDisplayRenderer()
           
 int getInstanceNumber()
           
abstract  java.lang.String getSaveString()
          get a string that can be used to reconstruct this control later
 long incTick()
          invoke incTick every time Control changes
 void nullControl()
          end this control
 boolean peekTicks(DataRenderer r, DataDisplayLink link)
           
 void removeControlListener(ControlListener listener)
          remove a ControlListener
 void resetTicks()
          reset tickFlag
abstract  void setSaveString(java.lang.String save)
          reconstruct this control using the specified save string
 void setTicks()
          set tickFlag according to OldTick and NewTick
 boolean subCheckTicks(DataRenderer r, DataDisplayLink link)
          run checkTicks on any sub-Controls; this default for no sub-Controls
 boolean subPeekTicks(DataRenderer r, DataDisplayLink link)
          run peekTicks on any sub-Controls; this default for no sub-Controls
 void subResetTicks()
          run resetTicks on any sub-Controls; this default for no sub-Controls
 void subSetTicks()
          run setTicks on any sub-Controls; this default for no sub-Controls
abstract  void syncControl(Control rmt)
          copy the state of a remote control to this control
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Control

public Control(DisplayImpl d)
Method Detail

getDisplayRenderer

public DisplayRenderer getDisplayRenderer()

changeControl

public void changeControl(boolean tick)
                   throws VisADException,
                          java.rmi.RemoteException
invoked every time values of this Control change; tick is true to notify the Display

Throws:
VisADException
java.rmi.RemoteException

addControlListener

public void addControlListener(ControlListener listener)
add a ControlListener


removeControlListener

public void removeControlListener(ControlListener listener)
remove a ControlListener


nullControl

public void nullControl()
end this control


incTick

public long incTick()
invoke incTick every time Control changes


setTicks

public void setTicks()
set tickFlag according to OldTick and NewTick


peekTicks

public boolean peekTicks(DataRenderer r,
                         DataDisplayLink link)

checkTicks

public boolean checkTicks(DataRenderer r,
                          DataDisplayLink link)
return true if Control changed and requires re-Transform


resetTicks

public void resetTicks()
reset tickFlag


subSetTicks

public void subSetTicks()
run setTicks on any sub-Controls; this default for no sub-Controls


subCheckTicks

public boolean subCheckTicks(DataRenderer r,
                             DataDisplayLink link)
run checkTicks on any sub-Controls; this default for no sub-Controls


subPeekTicks

public boolean subPeekTicks(DataRenderer r,
                            DataDisplayLink link)
run peekTicks on any sub-Controls; this default for no sub-Controls


subResetTicks

public void subResetTicks()
run resetTicks on any sub-Controls; this default for no sub-Controls


animation_string

public void animation_string(RealType real,
                             Set set,
                             double value,
                             int current)
                      throws VisADException
used by java3d.AnimationControlJ3D and java2d.AnimationControlJ2D

Throws:
VisADException

getInstanceNumber

public int getInstanceNumber()

getDisplay

public DisplayImpl getDisplay()

getSaveString

public abstract java.lang.String getSaveString()
get a string that can be used to reconstruct this control later


setSaveString

public abstract void setSaveString(java.lang.String save)
                            throws VisADException,
                                   java.rmi.RemoteException
reconstruct this control using the specified save string

Throws:
VisADException
java.rmi.RemoteException

syncControl

public abstract void syncControl(Control rmt)
                          throws VisADException
copy the state of a remote control to this control

Throws:
VisADException

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object