visad
Class ToggleControl

java.lang.Object
  visad.Control
      visad.ToggleControl

All Implemented Interfaces:

Serializable, Cloneable

public class ToggleControl
extends Control

ToggleControl is the VisAD class for toggling other Control-s on and off.

See Also:

Serialized Form

Constructor Summary

ToggleControl(DisplayImpl d, Control p)

Method Summary

boolean	equals(Object o) Indicates whether or not this instance equals an Object
boolean	getOn()
Control	getParent()
String	getSaveString() get a string that can be used to reconstruct this control later
void	setOn(boolean o)
void	setSaveString(String save) reconstruct this control using the specified save string
void	syncControl(Control rmt) copy the state of a remote control to this control

Methods inherited from class visad.Control

addControlListener, animation_string, changeControl, checkTicks, clone, getDisplay, getDisplayRenderer, getInstanceNumber, incTick, nullControl, peekTicks, removeControlListener, resetTicks, setTicks, subCheckTicks, subPeekTicks, subResetTicks, subSetTicks, toString

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ToggleControl

public ToggleControl(DisplayImpl d,
                     Control p)

Method Detail

getParent

public Control getParent()

getOn

public boolean getOn()

setOn

public void setOn(boolean o)
           throws VisADException,
                  RemoteException

Throws:

VisADException

RemoteException

getSaveString

public String getSaveString()

get a string that can be used to reconstruct this control later

Specified by:

getSaveString in class Control

Returns:

String representation of this Control

setSaveString

public void setSaveString(String save)
                   throws VisADException,
                          RemoteException

reconstruct this control using the specified save string

Specified by:

setSaveString in class Control

Parameters:

save - - String representation for reconstruction

Throws:

VisADException - if a VisAD error occurs

RemoteException - if an RMI error occurs

syncControl

public void syncControl(Control rmt)
                 throws VisADException

copy the state of a remote control to this control

Specified by:

syncControl in class Control

Parameters:

rmt - remote Control whose state is copied

Throws:

VisADException - if a VisAD error occurs

equals

public boolean equals(Object o)

Description copied from class: Control

Indicates whether or not this instance equals an Object

Overrides:

equals in class Control

Parameters:

o - an Object

Returns:

true if and only if this instance is equal to o