All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class ControlBeans.CRelay

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----com.sun.java.swing.JComponent
                           |
                           +----ControlBeans.CRelay

public class CRelay
extends JComponent
implements ComponentInterface
This class implements an invisible control component that can relay values between non-control components and the communicator. It does so by letting non-control components listen to relay events. When the component receives a relay event, it can fetch the value by invoking getIntValue, getDoubleValue or getStringValue. The non-control component can also send values to the communicator by invoking the corresponding set-methods.
It has been implemented as a Javabean, meaning that it is well suited to use within visual programming tools such as NetBeans or JBuilder.


Constructor Index

 o CRelay()
Constructs a new CRelay.

Method Index

 o addComponentListener(ComponentListener)
Registers a ComponentListener.
 o addRelayListener(RelayListener)
Registers a RelayListener.
 o getDoubleValue()
Gets the last received double value.
 o getIntValue()
Gets the last received integer value.
 o getIsReceiver()
Gets whether or not this component will send values.
 o getIsSender()
Gets whether or not this component will receive values.
 o getReceiveDoubleAsInt()
Gets whether or not this component will convert received double values to integer values before alerting the component connected to it.
 o getReceiveIntAsDouble()
Gets whether or not this component will convert received integer values to double values before alerting the component connected to it.
 o getSendDoubleAsInt()
Gets whether or not this component will convert received double values to integer values before passing them on to the communicator.
 o getSendIntAsDouble()
Gets whether or not this component will convert received integer values to double values before passing them on to the communicator.
 o getStringValue()
Gets the last received string value.
 o getTag()
Gets the tag of this component.
 o getTags()
The communicator uses this method to get all the tags used by this component.
 o putValue(double, int, double, int)
Sets the value of this component.
 o putValue(int, int, double, int)
Sets the value of this component.
 o putValue(String, int, double, int)
Sets the value of this component.
 o registerCommunicator(AbstractCommunicator, int)
The communicator uses this method to alert this component of its presence.
 o removeComponentListener(ComponentListener)
Deregisters the ComponentListener.
 o removeRelayListener(RelayListener)
Deregisters the RelayListener.
 o requestValues()
Called by the communicator to make this component send its value(s).
 o setDoubleValue(double)
Sends a double value to the communicator.
 o setIntValue(int)
Sends an integer value to the communicator.
 o setIsReceiver(boolean)
Sets whether or not this component should send values.
 o setIsSender(boolean)
Sets whether or not this component should receive values.
 o setReceiveDoubleAsInt(boolean)
Sets whether or not this component should convert received double values to integer values before alerting the component connected to it.
 o setReceiveIntAsDouble(boolean)
Sets whether or not this component should convert received integer values to double values before alerting the component connected to it.
 o setSendDoubleAsInt(boolean)
Sets whether or not this component should convert received double values to integer values before passing them on to the communicator.
 o setSendIntAsDouble(boolean)
Sets whether or not this component should convert received integer values to double values before passing them on to the communicator.
 o setStringValue(String)
Sends a string value to the communicator.
 o setTag(int)
Sets the tag of this component.

Constructors

 o CRelay
 public CRelay()
Constructs a new CRelay.

Methods

 o getIsSender
 public boolean getIsSender()
Gets whether or not this component will receive values.

Returns:
true if this component will receive values to the communicator; false otherwise.
 o setIsSender
 public void setIsSender(boolean value)
Sets whether or not this component should receive values.

Parameters:
value - true if this component should receive values from the communicator; false otherwise.
 o getIsReceiver
 public boolean getIsReceiver()
Gets whether or not this component will send values.

Returns:
true if this component will send values to the communicator; false otherwise.
 o setIsReceiver
 public void setIsReceiver(boolean value)
Sets whether or not this component should send values.

Parameters:
value - true if this component should send values to the communicator; false otherwise.
 o getReceiveDoubleAsInt
 public boolean getReceiveDoubleAsInt()
Gets whether or not this component will convert received double values to integer values before alerting the component connected to it.

Returns:
true if this component will convert double values to integer values; false otherwise.
 o setReceiveDoubleAsInt
 public void setReceiveDoubleAsInt(boolean value)
Sets whether or not this component should convert received double values to integer values before alerting the component connected to it.

Parameters:
value - true if this component should convert double values to integer values; false otherwise.
 o getReceiveIntAsDouble
 public boolean getReceiveIntAsDouble()
Gets whether or not this component will convert received integer values to double values before alerting the component connected to it.

Returns:
true if this component will convert integer values to double values; false otherwise.
 o setReceiveIntAsDouble
 public void setReceiveIntAsDouble(boolean value)
Sets whether or not this component should convert received integer values to double values before alerting the component connected to it.

Parameters:
value - true if this component should convert integer values to double values; false otherwise.
 o getSendDoubleAsInt
 public boolean getSendDoubleAsInt()
Gets whether or not this component will convert received double values to integer values before passing them on to the communicator.

Returns:
true if this component will convert double values to integer values; false otherwise.
 o setSendDoubleAsInt
 public void setSendDoubleAsInt(boolean value)
Sets whether or not this component should convert received double values to integer values before passing them on to the communicator.

Parameters:
value - true if this component should convert double values to integer values; false otherwise.
 o getSendIntAsDouble
 public boolean getSendIntAsDouble()
Gets whether or not this component will convert received integer values to double values before passing them on to the communicator.

Returns:
true if this component will convert integer values to double values; false otherwise.
 o setSendIntAsDouble
 public void setSendIntAsDouble(boolean value)
Sets whether or not this component should convert received integer values to double values before passing them on to the communicator.

Parameters:
value - true if this component should convert integer values to double values; false otherwise.
 o getTag
 public int getTag()
Gets the tag of this component. The tag is used to group different components within the communicator.

Returns:
the tag of this component
 o setTag
 public void setTag(int value)
Sets the tag of this component. The tag is used to group different components within the communicator.

Parameters:
value - the tag of this component
 o getIntValue
 public int getIntValue()
Gets the last received integer value. Typically invoked by a non-control component in order for it to recieve this value.

Returns:
the last integer value to be relayed through this component
 o setIntValue
 public void setIntValue(int value)
Sends an integer value to the communicator. Typically invoked by a non-control component in order for it to send its value to the communicator. The value is also stored. Before sending, this component checks to see if a conversion from integer to double has been requested.

Parameters:
value - the integer value to be relayed to the communicator
See Also:
getSendIntAsDouble, setSendIntAsDouble
 o getDoubleValue
 public double getDoubleValue()
Gets the last received double value. Typically invoked by a non-control component in order for it to recieve this value.

Returns:
the last double value to be relayed through this component
 o setDoubleValue
 public void setDoubleValue(double value)
Sends a double value to the communicator. Typically invoked by a non-control component in order for it to send its value to the communicator. The value is also stored. Before sending, this component checks to see if a conversion from double to integer has been requested.

Parameters:
value - the double value to be relayed to the communicator
See Also:
getSendDoubleAsInt, setSendDoubleAsInt
 o getStringValue
 public String getStringValue()
Gets the last received string value. Typically invoked by a non-control component in order for it to recieve this value.

Returns:
the last string value to be relayed through this component
 o setStringValue
 public void setStringValue(String value)
Sends a string value to the communicator. Typically invoked by a non-control component in order for it to send its value to the communicator. The value is also stored.

Parameters:
value - the string value to be relayed to the communicator
 o addComponentListener
 public void addComponentListener(ComponentListener l)
Registers a ComponentListener. By doing so the ComponentListener can receive component events from this component.
NOTE: This component can only hold one ComponentListener.

Parameters:
l - the ComponentListener to register.
 o removeComponentListener
 public void removeComponentListener(ComponentListener l)
Deregisters the ComponentListener.

Parameters:
l - the ComponentListener to remove.
 o registerCommunicator
 public void registerCommunicator(AbstractCommunicator c,
                                  int ID)
The communicator uses this method to alert this component of its presence.
NOTE: This method is invoked by AbstractCommunicator and should therefore never be called directly by the user.

Parameters:
c - the communicator in question
ID - the ID number assigned to this component and is stored in myID
See Also:
putValue, putValue, putValue
 o getTags
 public int[] getTags()
The communicator uses this method to get all the tags used by this component.
NOTE: This method is invoked by AbstractCommunicator and should therefore never be called directly by the user.

Returns:
all tags used by this component
 o putValue
 public void putValue(int value,
                      int aTag,
                      double time,
                      int ID)
Sets the value of this component.

Parameters:
value - the value to be set
aTag - the tag of the component
time - a time tag for the value
ID - the ID of the component
See Also:
registerCommunicator
 o putValue
 public void putValue(double value,
                      int aTag,
                      double time,
                      int ID)
Sets the value of this component.

Parameters:
value - the value to be set
aTag - the tag of the component
time - a time tag for the value
ID - the ID of the component
See Also:
registerCommunicator
 o putValue
 public void putValue(String value,
                      int aTag,
                      double time,
                      int ID)
Sets the value of this component.

Parameters:
value - the value to be set
aTag - the tag of the component
time - a time tag for the value
ID - the ID of the component
See Also:
registerCommunicator
 o requestValues
 public void requestValues()
Called by the communicator to make this component send its value(s). This can be used for initialization.

 o addRelayListener
 public void addRelayListener(RelayListener l)
Registers a RelayListener. By doing so the RelayListener can receive relay events from this component.
NOTE: This component can only hold one RelayListener.

Parameters:
l - the RelayListener to register.
 o removeRelayListener
 public void removeRelayListener(RelayListener l)
Deregisters the RelayListener.

Parameters:
l - the RelayListener to remove.

All Packages  Class Hierarchy  This Package  Previous  Next  Index