ciips.animation
Class  Legend
java.lang.Object
  |
  +--ciips.animation.Legend
- All Implemented Interfaces: 
 - DrawingObj
 
- public class Legend
- extends java.lang.Object
- implements DrawingObj
   
This is just another example implementation of the DrawingObj
 interface. It creates a small Legend describing the color code used
 in the drawing panel. This class has to be modified for different
 application. The draw method has to be re-implemented
 to reflex a particular application. This drawing object can be added
 to the drawing panel by: 
	drawingPanel.addDrawingObj(new Legend(x, y));
 
- See Also: 
 ComBox, 
IntMatrix
| 
Constructor Summary | 
Legend(int x,
       int y)
 
          Construct a legend object on the same drawing panel with the topleft
 corner specified by the parameters. | 
 
| 
Method Summary | 
 void | 
draw(java.awt.Graphics g)
 
          This method draws the details of the legend object on the appropriate
 graphical context, normally the drawing panel. | 
 int | 
getX()
 
          Get the left most position of the legend object. | 
 int | 
getY()
 
          Get the top most position of the legend object. | 
 void | 
move(int x,
     int y)
 
          Move the object to the position as specified by the parameter. | 
 
| Methods inherited from class java.lang.Object | 
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
 
Legend
public Legend(int x,
              int y)
- Construct a legend object on the same drawing panel with the topleft
 corner specified by the parameters.
- Parameters:
 x - Left most position of the legend object.y - Right most position of the legend object.
 
 
move
public void move(int x,
                 int y)
- Move the object to the position as specified by the parameter.
 This coordinate represents the topleft corner of the object.
- Specified by: 
 move in interface DrawingObj
 
- Parameters:
 x - The left most position of the legend object.y - The right most position of the legend object.
 
 
getX
public int getX()
- Get the left most position of the legend object. This method is not
 actually used. Just there for completeness when implementing the
 
DrawingObj interface.
- Specified by: 
 getX in interface DrawingObj
 
- Returns:
 - The left most position of the legend object.
 
 
 
getY
public int getY()
- Get the top most position of the legend object. This method is not
 actually used. Just there for completeness when implementing the
 
DrawingObj interface.
- Specified by: 
 getY in interface DrawingObj
 
- Returns:
 - The top most position of the legend object.
 
 
 
draw
public void draw(java.awt.Graphics g)
- This method draws the details of the legend object on the appropriate
 graphical context, normally the drawing panel.
 This method has to be modified for various application.
- Specified by: 
 draw in interface DrawingObj
 
- Following copied from interface: 
ciips.animation.DrawingObj 
- Parameters:
 g - A reference to the graphical context.