org.ginsim.gui.graph.canvas

Class SimpleCanvas

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.ginsim.gui.graph.canvas.SimpleCanvas

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, VirtualScrollable

public class SimpleCanvas
extends JComponent
implements VirtualScrollable

A simple canvas component. This component has a zoom level and translation and lets a separate renderer draw the content (without having to know about coordinate transformations) Mouse events that are not caught for zooming and dragging are also passed to the renderer (which can use them for example to select and move items). The Base canvas is also in charge for the scroll bars. Scroll bars appear when the renderer declared area is not entirely visible. The canvas allows scrolling further than the declared area, by a margin depending on the window size and zoom level. Note: scroll bars are not interactive yet.

Author:

Aurelien Naldi

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, 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
SimpleCanvas()

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	clearOffscreen() Throw away the cached image.
void	damageCanvas(Rectangle area) Mark a part of the canvas as needing to be redrawn.
Component	getComponent() Get the component for this view.
BufferedImage	getNewBufferedImage()
Dimension	getVirtualDimension() Get the full virtual size of this widget.
Rectangle	getVisibleArea() Get the part of the virtual size that is currently visible.
double	getZoomLevel()
void	help()
protected void	paintComponent(Graphics g)
void	reshape(int x, int y, int w, int h)
void	scroll(int wheelRotation, boolean alternate)
void	setRenderer(CanvasRenderer renderer)
void	setScrollPane(VirtualScrollPane scrollPane) Associate the view with a scrollPane.
void	setScrollPosition(int x, int y) Scroll this view to a specified position.
protected Point	window2canvas(Point p)
void	zoom(ZoomEffect effect)

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SimpleCanvas

public SimpleCanvas()

Method Detail

setRenderer

public void setRenderer(CanvasRenderer renderer)

setScrollPane

public void setScrollPane(VirtualScrollPane scrollPane)

Description copied from interface: VirtualScrollable

Associate the view with a scrollPane. The view will then fire events upon view changes.

Specified by:

setScrollPane in interface VirtualScrollable

getNewBufferedImage

public BufferedImage getNewBufferedImage()

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

getComponent

public Component getComponent()

Description copied from interface: VirtualScrollable

Get the component for this view.

Specified by:

getComponent in interface VirtualScrollable

Returns:

a component to add in the scrollPane

getVirtualDimension

public Dimension getVirtualDimension()

Description copied from interface: VirtualScrollable

Get the full virtual size of this widget. This is used by the scrollpane to define the ranges of the scrollbars.

Specified by:

getVirtualDimension in interface VirtualScrollable

Returns:

the Dimension of the space in which the visibleArea can move

getVisibleArea

public Rectangle getVisibleArea()

Description copied from interface: VirtualScrollable

Get the part of the virtual size that is currently visible. This allows the scrollpane to define the positions of the scrollbars.

Specified by:

getVisibleArea in interface VirtualScrollable

Returns:

a rectangle providing the bounds of the visible area.

zoom

public void zoom(ZoomEffect effect)

getZoomLevel

public double getZoomLevel()

setScrollPosition

public void setScrollPosition(int x,
                              int y)

Description copied from interface: VirtualScrollable

Scroll this view to a specified position.

Specified by:

setScrollPosition in interface VirtualScrollable

window2canvas

protected Point window2canvas(Point p)

scroll

public void scroll(int wheelRotation,
                   boolean alternate)

damageCanvas

public void damageCanvas(Rectangle area)

Mark a part of the canvas as needing to be redrawn. It will transform the canvas area into screen coordinates and call damageScreen. Note: this does NOT call repaint to let several calls happen before the actual redraw.

Parameters:

area - the canvas area to mark as damaged

clearOffscreen

public void clearOffscreen()

Throw away the cached image. The next repaint will have to build the image from scratch. Should be called when changing the zoom level or after a general layout change.

cancel

public void cancel()

help

public void help()

reshape

public void reshape(int x,
                    int y,
                    int w,
                    int h)

Overrides:

reshape in class JComponent