EDU.utwente.CoCompose.gui
Class ViewportScroller

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--EDU.utwente.CoCompose.gui.ViewportScroller
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class ViewportScroller
extends javax.swing.JPanel

A ViewportScroller is a window used to scroll a window through a larger area of content. The content is shown as a white rectangle, with the window being represented by a black rectangle outline within it. A StateChanged event is fired when the user drags the "window" with the mouse. Based upon EDU.auburn.VGJ.gui.ViewportScroller. Adapted for use with Swing.

Version:
0.0.16, 23 March 2002
Author:
Dennis Wagelaar, Larry Barowski
See Also:
ViewportScroller, Serialized Form

Inner classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Inner classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent
 
Field Summary
protected  javax.swing.event.ChangeEvent changeEvent
          Only one ChangeEvent is needed per instance since the event's only state is the source property.
 
Fields inherited from class javax.swing.JComponent
accessibleContext, 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
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
ViewportScroller()
          Constructs a ViewPortScroller
 
Method Summary
 void addChangeListener(javax.swing.event.ChangeListener l)
          Adds a ChangeListener to the viewport scroller.
protected  void fireStateChanged()
          Notifies all listeners that have registered interest for notification on this event type.
 java.awt.Color getBackColor()
          Gets the background drawing color.
 DDimension getContentSize()
          gets the content size.
 java.awt.Color getLineColor()
          Gets the line drawing color.
 DPoint getOffset()
          Gets the viewport offset. return The viewport offset.
 DDimension getPortSize()
          Gets the viewport size.
 boolean isDragging()
          Returns whether the mouse is dragging.
protected  void paintComponent(java.awt.Graphics g)
          Paints the viewport elements on top of the panel.
protected  void paintComponentBuffer(java.awt.Graphics g)
          Paints the viewport elements on top of the panel.
 void removeChangeListener(javax.swing.event.ChangeListener l)
          Removes a ChangeListener from the viewport scroller.
 void setBackColor(java.awt.Color color)
          Sets the background drawing color.
 void setContentSize(DDimension size)
          Sets the content size.
 void setLineColor(java.awt.Color color)
          Sets the line drawing color.
 void setOffset(DPoint offset)
          Sets the viewport offset. param offset The viewport offset.
 void setPortSize(DDimension size)
          Sets the viewport size.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUIClassID, paramString, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

changeEvent

protected transient javax.swing.event.ChangeEvent changeEvent
Only one ChangeEvent is needed per instance since the event's only state is the source property. The source of events generated is always "this".
Constructor Detail

ViewportScroller

public ViewportScroller()
Constructs a ViewPortScroller
Method Detail

paintComponent

protected void paintComponent(java.awt.Graphics g)
Paints the viewport elements on top of the panel.
Overrides:
paintComponent in class javax.swing.JComponent
Parameters:
g - The graphics context.

paintComponentBuffer

protected void paintComponentBuffer(java.awt.Graphics g)
Paints the viewport elements on top of the panel. Does a partial paint by using the backbuffer.
Parameters:
g - The graphics context.

fireStateChanged

protected void fireStateChanged()
Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fire method.
See Also:
EventListenerList

getPortSize

public DDimension getPortSize()
Gets the viewport size.
Returns:
The viewport size.

setPortSize

public void setPortSize(DDimension size)
Sets the viewport size.
Parameters:
size - The viewport size.

getContentSize

public DDimension getContentSize()
gets the content size.
Returns:
The content size.

setContentSize

public void setContentSize(DDimension size)
Sets the content size.
Parameters:
size - The content size.

getOffset

public DPoint getOffset()
Gets the viewport offset. return The viewport offset.

setOffset

public void setOffset(DPoint offset)
Sets the viewport offset. param offset The viewport offset.

getBackColor

public java.awt.Color getBackColor()
Gets the background drawing color.
Returns:
The background drawing color.

setBackColor

public void setBackColor(java.awt.Color color)
Sets the background drawing color.
Parameters:
color - The background drawing color.

getLineColor

public java.awt.Color getLineColor()
Gets the line drawing color.
Returns:
The line drawing color.

setLineColor

public void setLineColor(java.awt.Color color)
Sets the line drawing color.
Parameters:
color - The line drawing color.

isDragging

public boolean isDragging()
Returns whether the mouse is dragging.
Returns:
True if and only if the mouse is dragging.

addChangeListener

public void addChangeListener(javax.swing.event.ChangeListener l)
Adds a ChangeListener to the viewport scroller.
Parameters:
l - the listener to be added

removeChangeListener

public void removeChangeListener(javax.swing.event.ChangeListener l)
Removes a ChangeListener from the viewport scroller.
Parameters:
l - the listener to be removed