g2d.swing

Class IOPView

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

g2d.swing.IOPView

All Implemented Interfaces:

ZoomListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.swing.event.ChangeListener

public class IOPView
extends javax.swing.JComponent
implements ZoomListener, javax.swing.event.ChangeListener

View of one IOPComponent to be inserted into top-level container such as IOPFrame.

The following figure shows how an IOPView is composed. The toolbar with standard zooming buttons and an output area in a split pane are optional. Without an output area, no split pane is used.

Since:

August 2004

Author:

Ben Funnell, Ian Mason, and Linda@SRI

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.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
IOPView()
IOPView(boolean scrollbars, boolean toolbar)
IOPView(boolean scrollbars, boolean toolbar, boolean output) Create an IOPView with given parameters.
IOPView(Glyphish glyphs)
IOPView(Glyphish glyphs, java.awt.geom.AffineTransform position)
IOPView(Glyphish glyphs, boolean scrollbars, boolean toolbar)
IOPView(Glyphish glyphs, boolean scrollbars, boolean toolbar, boolean output)

Method Summary

Modifier and Type	Method and Description
void	add(Glyphish glyphs)
void	add(Glyphish glyphs, java.awt.geom.AffineTransform position)
void	addButton(javax.swing.AbstractButton button)
void	addButton(javax.swing.AbstractButton button, int i)
void	addMItem(IOPMenuItem item) Adds a new menu item to the currently active text menu in output.
void	addOutput() Adds a text output area at bottom of this view if it doesn't exist yet.
void	addToolBar()
void	addZoomListener(ZoomListener zl) Add given zoom listener to list of objects to be notified upon zoom change.
void	centerOn(Glyphish g) Deprecated. use combination of getIOPComponent() and IOPComponent.centerOn(java.awt.geom.Rectangle2D) instead
void	centerOn(java.awt.geom.Rectangle2D rect) Deprecated. use combination of getIOPComponent() and IOPComponent.centerOn(java.awt.geom.Rectangle2D) instead
void	checkSize()
void	clearOutput() Clear output area (if output set).
void	displayText(java.lang.String label, java.lang.String text, boolean closebutton) Display label and text in output area (if output set).
void	displayTextMenu(java.lang.String label, java.util.List<?> list) Display new text menu in output area (if output set).
IOPComponent	getIOPComponent()
IOPScrollPane	getScrollPane()
IOPToolBar	getToolBar()
java.awt.Dimension	getVisible() Obtain dimension of visible part of IOPComponent.
double	getZoom() Obtain current zoom factor in effect for embedded glyphs.
void	remove(Glyphish glyphs)
void	removeZoomListener(ZoomListener zl) Remove given zoom listener from list of objects to be notified upon zoom change.
void	requestFocus()
void	setGraph(IOPGraph graph)
void	setKeyAction(int type, Closure fun)
void	setMouseAction(int type, Closure fun)
void	setPreferredSize(int width, int height) Deprecated. JComponent.setPreferredSize(java.awt.Dimension) instead.
void	stateChanged(javax.swing.event.ChangeEvent event)
void	zoom(double factor) Apply given factor to current zoom.
java.awt.geom.Rectangle2D	zoomBound(java.awt.geom.Rectangle2D bound)
void	zoomChanged(double scale) Called when zoom has changed.
void	zoomIn() Zoom in by static factor.
void	zoomOut() Zoom out by static factor.
java.awt.geom.Point2D	zoomPoint(java.awt.event.MouseEvent e)
void	zoomToFit() Zoom to fit to current view port.
void	zoomToFit(double width, double height)
void	zoomToFit(java.awt.geom.Rectangle2D rect) Zoom to fit to given rectangle.

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, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, 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

IOPView

public IOPView()

IOPView

public IOPView(Glyphish glyphs)

IOPView

public IOPView(boolean scrollbars,
               boolean toolbar)

IOPView

public IOPView(Glyphish glyphs,
               java.awt.geom.AffineTransform position)

IOPView

public IOPView(boolean scrollbars,
               boolean toolbar,
               boolean output)

Create an IOPView with given parameters. Initial (preferred) size is 40% width and 90% height of available screen size.

Parameters:

scrollbars - Whether to display scrollbars for IOPComponent

toolbar - Whether to include the standard toolbar with zooming buttons

output - Whether to reserve space for an output panel to be included in a split pane

IOPView

public IOPView(Glyphish glyphs,
               boolean scrollbars,
               boolean toolbar)

IOPView

public IOPView(Glyphish glyphs,
               boolean scrollbars,
               boolean toolbar,
               boolean output)

Method Detail

getIOPComponent

public IOPComponent getIOPComponent()

getToolBar

public IOPToolBar getToolBar()

getScrollPane

public IOPScrollPane getScrollPane()

addToolBar

public void addToolBar()

addButton

public void addButton(javax.swing.AbstractButton button)

addButton

public void addButton(javax.swing.AbstractButton button,
                      int i)

addOutput

public void addOutput()

Adds a text output area at bottom of this view if it doesn't exist yet. Uses default values for the size of document behind text area. Turns editing of text area off. Encloses text area in scroll pane.

clearOutput

public void clearOutput()

Clear output area (if output set).

displayText

public void displayText(java.lang.String label,
                        java.lang.String text,
                        boolean closebutton)

Display label and text in output area (if output set).

Parameters:

label - Short label to be used as heading

text - Text to be displayed (not wrapped in text area)

closebutton - Indicates whether to display a button to close text area with output

displayTextMenu

public void displayTextMenu(java.lang.String label,
                            java.util.List<?> list)

Display new text menu in output area (if output set). Shows a given label as heading and displays list of IOPMenuItems to be selected by user. If user clicks or issues key binding, will execute associated action according to IOPMenuItem (if set). Menu will not disappear from output after action --- calling program must take care of this itself (to avoid problems if action invokes text output or another text menu).

Parameters:

label - String used as heading for menu

list - List of IOPMenuItems filling menu

See Also:

IOPMenuItem

addMItem

public void addMItem(IOPMenuItem item)

Adds a new menu item to the currently active text menu in output. If output is currently not an active IOPTextMenu, nothing happens.

Parameters:

item - IOPMenuItem to be added

setGraph

public void setGraph(IOPGraph graph)

add

public void add(Glyphish glyphs)

add

public void add(Glyphish glyphs,
                java.awt.geom.AffineTransform position)

remove

public void remove(Glyphish glyphs)

addZoomListener

public void addZoomListener(ZoomListener zl)

Add given zoom listener to list of objects to be notified upon zoom change.

Parameters:

zl - ZoomListener to be notified upon zoom change

removeZoomListener

public void removeZoomListener(ZoomListener zl)

Remove given zoom listener from list of objects to be notified upon zoom change.

Parameters:

zl - ZoomListener to be removed

zoomChanged

public void zoomChanged(double scale)

Description copied from interface: ZoomListener

Called when zoom has changed.

Specified by:

zoomChanged in interface ZoomListener

Parameters:

scale - New zoom scale that is in effect

getZoom

public double getZoom()

Obtain current zoom factor in effect for embedded glyphs.

Returns:

Current scaling factor in effect for x- and y-axis

zoom

public void zoom(double factor)

Apply given factor to current zoom. A value smaller than 1.0 means zooming out (everything becomes smaller). A value greater than 1.0 means zooming in (everything becomes bigger).

Parameters:

factor - Zoom factor to apply

zoomIn

public void zoomIn()

Zoom in by static factor.

zoomOut

public void zoomOut()

Zoom out by static factor.

zoomToFit

public void zoomToFit()

Zoom to fit to current view port.

zoomToFit

public void zoomToFit(java.awt.geom.Rectangle2D rect)

Zoom to fit to given rectangle.

Parameters:

rect - Rectangle

zoomToFit

public void zoomToFit(double width,
                      double height)

Parameters:

width - the desired width

height - the desired height

setMouseAction

public void setMouseAction(int type,
                           Closure fun)

setKeyAction

public void setKeyAction(int type,
                         Closure fun)

centerOn

public void centerOn(Glyphish g)

Deprecated. use combination of getIOPComponent() and IOPComponent.centerOn(java.awt.geom.Rectangle2D) instead

Parameters:

g - the glyph that wants the attention

centerOn

public void centerOn(java.awt.geom.Rectangle2D rect)

Deprecated. use combination of getIOPComponent() and IOPComponent.centerOn(java.awt.geom.Rectangle2D) instead

Parameters:

rect - the rectangle

getVisible

public java.awt.Dimension getVisible()

Obtain dimension of visible part of IOPComponent. Adjusted by a few pixels to prevent rounding errors.

Returns:

Dimension of visible part of IOPComponent

setPreferredSize

public void setPreferredSize(int width,
                             int height)

Deprecated. JComponent.setPreferredSize(java.awt.Dimension) instead.

For backward compatibility.

Parameters:

width - the preferred width.

height - the preferred height.

checkSize

public void checkSize()

requestFocus

public void requestFocus()

Overrides:

requestFocus in class javax.swing.JComponent

zoomPoint

public java.awt.geom.Point2D zoomPoint(java.awt.event.MouseEvent e)

zoomBound

public java.awt.geom.Rectangle2D zoomBound(java.awt.geom.Rectangle2D bound)

stateChanged

public void stateChanged(javax.swing.event.ChangeEvent event)

Specified by:

stateChanged in interface javax.swing.event.ChangeListener