All Packages Class Hierarchy This Package Previous Next Index
Class ControlBeans.CBarGauge
java.lang.Object
|
+----java.awt.Component
|
+----java.awt.Container
|
+----com.sun.java.swing.JComponent
|
+----com.sun.java.swing.JProgressBar
|
+----ControlBeans.CBarGauge
- public class CBarGauge
- extends JProgressBar
- implements ComponentInterface
This class implements a progressbar as a simple bar gauge.
Its purpose is to provide the user with a visual indicator.
This is a passive component, meaning that it will never itself send
any values to the communicator.
It has been implemented as a Javabean, meaning that it is well suited
to use within visual programming tools such as NetBeans or JBuilder.
- See Also:
- AbstractCommunicator
-
CBarGauge()
- Constructs a new CBarGauge.
-
addComponentListener(ComponentListener)
- Registers a ComponentListener.
-
getIsReceiver()
- Gets whether or not this component will receive values.
-
getIsSender()
- Gets whether or not this component will send values.
-
getTag()
- Gets the tag of this component.
-
getTags()
- The communicator uses this method to get all the tags used by this
component.
-
putValue(double, int, double, int)
- Sets the value of this component.
-
putValue(int, int, double, int)
- Sets the value of this component.
-
putValue(String, int, double, int)
- Sets the value for this component.
-
registerCommunicator(AbstractCommunicator, int)
- The communicator uses this method to alert this component of its
presence.
-
removeComponentListener(ComponentListener)
- Deregisters the ComponentListener.
-
requestValues()
- Called by the communicator to make this component send its value(s).
-
setIsReceiver(boolean)
- Sets whether or not this component should receive values.
-
setIsSender(boolean)
- Sets whether or not this component should send values.
-
setTag(int)
- Sets the tag of this component.
CBarGauge
public CBarGauge()
- Constructs a new CBarGauge.
getIsReceiver
public boolean getIsReceiver()
- Gets whether or not this component will receive values.
- Returns:
-
true
if this component will receive values from the
communicator;
false
otherwise.
setIsReceiver
public void setIsReceiver(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.
getIsSender
public boolean getIsSender()
- Gets whether or not this component will send values.
NOTE: Implemented for compatibility reasons only. This component cannot
send values, hence this method will always return false.
- Returns:
-
true
if this component will send values to the
communicator;
false
otherwise.
setIsSender
public void setIsSender(boolean value)
- Sets whether or not this component should send values.
NOTE: Implemented for compatibility reasons only. This component cannot
send values, hence calling this method will have no effect.
- Parameters:
- value -
true
if this component should send values
to the communicator;
false
otherwise.
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
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
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.
removeComponentListener
public void removeComponentListener(ComponentListener l)
- Deregisters the ComponentListener.
- Parameters:
- l - the ComponentListener to remove.
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
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
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
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
putValue
public void putValue(String value,
int aTag,
double time,
int ID)
- Sets the value for this component.
NOTE: Implemented for compatibility reasons only. This component cannot
receive string values, hence calling this method will have no effect.
- 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
requestValues
public void requestValues()
- Called by the communicator to make this component send its value(s).
This can be used for initialization.
NOTE: Implemented for compatibility reasons only. This component
does not send values, hence calling this method will have no effect,
All Packages Class Hierarchy This Package Previous Next Index