simulator.outputFeatures.graph

Class Paper

java.lang.Object

java.awt.Component

java.awt.Canvas

simulator.outputFeatures.graph.Paper

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

Direct Known Subclasses:

GraphPaper

public class Paper
extends java.awt.Canvas
implements java.awt.event.MouseMotionListener, java.awt.event.MouseListener

This is the paper class. This class is the graph paper and every thing has to be put in it. One can add layers. Scaling is provided.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Paper.GridLayer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
double	xScale xScale : for storing the same
double	yScale yScale : for storing the same

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
Paper() This is the only available constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayer(Layer l) Add a layer.
void	drawGraph() This is the methos that should be called to draw the graph.
Paper.GridLayer	getGridInstance() gets the instance of the grid layer.
LineLayer	getProfileLayer()
LineLayer	getSignalLayer()
Paper.GridLayer	getXGrid() Sets the grid for the X axis
double	getXScale() gets the scaling factor in the x direction
Paper.GridLayer	getYGrid() Sets the grid for the Y axis
double	getYScale() gets the scaling factor in the Y direction
void	mouseClicked(java.awt.event.MouseEvent m) (non-Javadoc)
void	mouseDragged(java.awt.event.MouseEvent m) (non-Javadoc)
void	mouseEntered(java.awt.event.MouseEvent m) (non-Javadoc)
void	mouseExited(java.awt.event.MouseEvent m) (non-Javadoc)
void	mouseMoved(java.awt.event.MouseEvent m) (non-Javadoc)
void	mousePressed(java.awt.event.MouseEvent m) (non-Javadoc)
void	mouseReleased(java.awt.event.MouseEvent m) (non-Javadoc)
void	paint(java.awt.Graphics g) (non-Javadoc)
void	removeLayer(Layer l) Remove a layer.
void	setGrid(Paper.GridLayer x, Paper.GridLayer y) Sets the grid layers of the paper.
void	setOrigin(float x, float y) This sets the Origin with respect to the bottom left corner of the paper.
void	setProfileLayer(LineLayer profileLayer)
void	setScale(double x, double y) Scale the graph.
void	setSignalLayer(LineLayer signalLayer)
void	setXGrid(Paper.GridLayer x) Sets the grid for the X axis
void	setYGrid(Paper.GridLayer y) Sets the grid for the Y axis

Methods inherited from class java.awt.Canvas

addNotify, createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy, update

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, dispatchEvent, doLayout, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

xScale

public double xScale

xScale : for storing the same

yScale

public double yScale

yScale : for storing the same

Constructor Detail

Paper

public Paper()

This is the only available constructor

Method Detail

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent m)

(non-Javadoc)

Specified by:

mouseClicked in interface java.awt.event.MouseListener

See Also:

MouseListener.mouseClicked(java.awt.event.MouseEvent)

mousePressed

public void mousePressed(java.awt.event.MouseEvent m)

(non-Javadoc)

Specified by:

mousePressed in interface java.awt.event.MouseListener

See Also:

MouseListener.mousePressed(java.awt.event.MouseEvent)

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent m)

(non-Javadoc)

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

See Also:

MouseMotionListener.mouseDragged(java.awt.event.MouseEvent)

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent m)

(non-Javadoc)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

See Also:

MouseListener.mouseReleased(java.awt.event.MouseEvent)

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent m)

(non-Javadoc)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

See Also:

MouseListener.mouseEntered(java.awt.event.MouseEvent)

mouseExited

public void mouseExited(java.awt.event.MouseEvent m)

(non-Javadoc)

Specified by:

mouseExited in interface java.awt.event.MouseListener

See Also:

MouseListener.mouseExited(java.awt.event.MouseEvent)

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent m)

(non-Javadoc)

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

See Also:

MouseMotionListener.mouseMoved(java.awt.event.MouseEvent)

addLayer

public void addLayer(Layer l)

Add a layer.

Parameters:

l -

removeLayer

public void removeLayer(Layer l)

Remove a layer.

Parameters:

l -

setScale

public void setScale(double x,
            double y)

Scale the graph. everything in the graph paer is scaled, including the strings. Later on a mgnify method may be provided for magnifying a portion of the graph. every time it is called the scale is set to the one sopecified by the one in the parameters.

Parameters:

x -

y -

getXScale

public double getXScale()

gets the scaling factor in the x direction

Returns:

xScale

getYScale

public double getYScale()

gets the scaling factor in the Y direction

Returns:

yScale

setOrigin

public void setOrigin(float x,
             float y)

This sets the Origin with respect to the bottom left corner of the paper. The utility of this method is to set the origin so that the strings displayed with the x and y axis are displayed properly without overlapping

Parameters:

x -

y -

setXGrid

public void setXGrid(Paper.GridLayer x)

Sets the grid for the X axis

Parameters:

x -

setYGrid

public void setYGrid(Paper.GridLayer y)

Sets the grid for the Y axis

Parameters:

y -

setGrid

public void setGrid(Paper.GridLayer x,
           Paper.GridLayer y)

Sets the grid layers of the paper. These layers should contain the grid lines which will draw the grid for the graph.

Parameters:

x -

y -

getGridInstance

public Paper.GridLayer getGridInstance()

gets the instance of the grid layer.

Returns:

new instance of gridlayer

getYGrid

public Paper.GridLayer getYGrid()

Sets the grid for the Y axis

Returns:

yGrid

getXGrid

public Paper.GridLayer getXGrid()

Sets the grid for the X axis

Returns:

xGrid

drawGraph

public void drawGraph()

This is the methos that should be called to draw the graph.

paint

public void paint(java.awt.Graphics g)

(non-Javadoc)

Overrides:

paint in class java.awt.Canvas

See Also:

Canvas.paint(java.awt.Graphics)

getProfileLayer

public LineLayer getProfileLayer()

setProfileLayer

public void setProfileLayer(LineLayer profileLayer)

getSignalLayer

public LineLayer getSignalLayer()

setSignalLayer

public void setSignalLayer(LineLayer signalLayer)