edu.rit.swing

Class DisplayableFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

edu.rit.swing.DisplayableFrame

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class DisplayableFrame
extends javax.swing.JFrame

Class DisplayableFrame is a Swing JFrame for viewing a Displayable object on the screen. The displayable object is specified when the viewer is constructed.

To display a displayable object in a window on the screen, construct an instance of class DisplayableFrame; call setSize() to set the viewer window's size if desired; and call setVisible(true) to display the viewer window.

The viewer window includes a "File" menu with menu items for saving the display in a PNG file, saving the display in a PostScript file, and closing the window.

The viewer window includes a "View" menu with menu items for zooming in and out. When the display is saved in a PNG file, the display is saved at its zoomed size. When the display is saved in a PostScript file, the display is saved at its normal (unzoomed) size.

When the viewer window is closed, either by using the "File" menu or by clicking the window's close box, one of three possible operations is performed: hide the window; hide and dispose the window; or exit the application. The close operation is specified when the viewer window is constructed. The default close operation is to hide and dispose the window.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DisplayableFrame.FileSaver Interface DisplayableFrame.FileSaver specifies the interface for an object that saves information in a file.

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

java.awt.Window.Type

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JFrame

EXIT_ON_CLOSE

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
DisplayableFrame(Displayable theDisplayable) Construct a new displayable object viewer.
DisplayableFrame(Displayable theDisplayable, int theCloseOperation) Construct a new displayable object viewer.
DisplayableFrame(java.lang.String theTitle, Displayable theDisplayable) Construct a new displayable object viewer with the given title.
DisplayableFrame(java.lang.String theTitle, Displayable theDisplayable, int theCloseOperation) Construct a new displayable object viewer with the given title.

Method Summary

Modifier and Type	Method and Description
void	display(Displayable theDisplayable) Tell this displayable object viewer to display the given displayable object.
void	saveFile(java.lang.String theExtension, java.lang.String theDescription, DisplayableFrame.FileSaver theFileSaver) Perform a file save operation.
void	setDefaultCloseOperation(int operation) Set the operation to be performed when the frame is closed.

Methods inherited from class javax.swing.JFrame

getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

DisplayableFrame

public DisplayableFrame(Displayable theDisplayable)

Construct a new displayable object viewer. The frame has no title. The frame is initially invisible. When the frame is closed, the frame is hidden and disposed.

Parameters:

theDisplayable - Displayable object.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if theDisplayable is null.

DisplayableFrame

public DisplayableFrame(java.lang.String theTitle,
                        Displayable theDisplayable)

Construct a new displayable object viewer with the given title. The frame is initially invisible. When the frame is closed, the frame is hidden and disposed.

Parameters:

theTitle - Title.

theDisplayable - Displayable object.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if theDisplayable is null.

DisplayableFrame

public DisplayableFrame(Displayable theDisplayable,
                        int theCloseOperation)

Construct a new displayable object viewer. The frame has no title. The frame is initially invisible. When the frame is closed, theCloseOperation specifies what to do.

Parameters:

theDisplayable - Displayable object.

theCloseOperation - What to do when the frame is closed, one of the following: JFrame.HIDE_ON_CLOSE, JFrame.DISPOSE_ON_CLOSE, or JFrame.EXIT_ON_CLOSE.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if theDisplayable is null.

java.lang.IllegalArgumentException - (unchecked exception) Thrown if theCloseOperation is invalid.

DisplayableFrame

public DisplayableFrame(java.lang.String theTitle,
                        Displayable theDisplayable,
                        int theCloseOperation)

Construct a new displayable object viewer with the given title. The frame is initially invisible. When the frame is closed, theCloseOperation specifies what to do.

Parameters:

theTitle - Title.

theDisplayable - Displayable object.

theCloseOperation - What to do when the frame is closed, one of the following: JFrame.HIDE_ON_CLOSE, JFrame.DISPOSE_ON_CLOSE, or JFrame.EXIT_ON_CLOSE.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if theDisplayable is null.

java.lang.IllegalArgumentException - (unchecked exception) Thrown if theCloseOperation is invalid.

Method Detail

setDefaultCloseOperation

public void setDefaultCloseOperation(int operation)

Set the operation to be performed when the frame is closed.

Overrides:

setDefaultCloseOperation in class javax.swing.JFrame

Parameters:

operation - One of the following constants defined in class javax.swing.JFrame: HIDE_ON_CLOSE, DISPOSE_ON_CLOSE, EXIT_ON_CLOSE.

display

public void display(Displayable theDisplayable)

Tell this displayable object viewer to display the given displayable object.

Parameters:

theDisplayable - Displayable object.

Throws:

java.lang.NullPointerException - (unchecked exception) Thrown if theDisplayable is null.

saveFile

public void saveFile(java.lang.String theExtension,
                     java.lang.String theDescription,
                     DisplayableFrame.FileSaver theFileSaver)

Perform a file save operation. This method displays a file chooser dialog listing files with the given extension; lets the user pick one; if the chosen file exists, displays a dialog asking the user if it's okay to overwrite the file; if all is well, calls the given file saver object's saveFile() method, passing in the chosen file; if an IOException occurs, displays a dialog with an error message.

Parameters:

theExtension - File extension for the file type to save.

theDescription - Description of the file type to save.

theFileSaver - File saver object.