Package org.xj3d.ui.awt.widgets

Class SwingConsoleWindow

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.xj3d.ui.awt.widgets.SwingConsoleWindow

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, org.j3d.util.ErrorReporter, ErrorHandler

public class SwingConsoleWindow
extends JFrame
implements ActionListener, ErrorHandler, org.j3d.util.ErrorReporter

A window that can act as console for error messages from the application.

The window will print error messages for all the error levels and only throw an exception for the fatalError.

Version:

$Revision: 1.5 $

Author:

Justin Couch

See Also:

• Serialized Form

Nested Class Summary

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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.JFrame

accessibleContext, rootPane, rootPaneCheckingEnabled

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 java.awt.image.ImageObserver

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
SwingConsoleWindow()	Create an instance of the console window.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent evt)	Process the action generated from the user interface.
void	error(VRMLException vpe)	Notification of a recoverable error in the parsing.
void	errorReport(String msg, Throwable e)	Notification of a recoverable error.
void	fatalError(VRMLException vpe)	Notification of a non-recoverable error.
void	fatalErrorReport(String msg, Throwable e)	Notification of a non-recoverable error that halts the entire system.
final void	messageReport(String msg)	Notification of an informational message from the system.
void	partialReport(String msg)	Notification of an partial message from the system.
void	redirectSystemMessages()	Redirect system messages to the console.
void	setDocumentLocator(DocumentLocator loc)	Set the document locator that can be used by the implementing code to find out information about the current line information.
void	warning(VRMLException vpe)	Notification of a warning in the way the code has been handled.
void	warningReport(String msg, Throwable e)	Notification of a warning in the way the system is currently operating.

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, 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, processEvent, processWindowFocusEvent, processWindowStateEvent, 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, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, 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, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Details

SwingConsoleWindow

public SwingConsoleWindow()

Create an instance of the console window.

Method Details

setDocumentLocator

public void setDocumentLocator(DocumentLocator loc)

Set the document locator that can be used by the implementing code to find out information about the current line information. This method is called by the parser to your code to give you a locator to work with. If this has not been set by the time startDocument() has been called, you can assume that you will not have one available.

Specified by:

setDocumentLocator in interface ErrorHandler

Parameters:

loc - The locator instance to use

warning

public void warning(VRMLException vpe)
             throws VRMLException

Notification of a warning in the way the code has been handled. The parser will continue through the file after this. Throw another exception if we want the parser to halt as a result.

Parameters:

vpe - The exception that caused this warning

Throws:

VRMLException - Create a further warning condition

error

public void error(VRMLException vpe)
           throws VRMLException

Notification of a recoverable error in the parsing. The parser will continue to keep parsing after this error. Throw another exception if we really want the parser to stop at this point.

Parameters:

vpe - The exception that caused this warning

Throws:

VRMLException - Create a further warning condition

fatalError

public void fatalError(VRMLException vpe)
                throws VRMLException

Notification of a non-recoverable error. The parser will not continue after calling this method. Throw another exception if we really want to make note of this, the parser will stop anyway.

Parameters:

vpe - The exception that caused this warning

Throws:

VRMLException - Create a further warning condition

partialReport

public void partialReport(String msg)

Notification of an partial message from the system. When being written out to a display device, a partial message does not have a line termination character appended to it, allowing for further text to appended on that same line.

Specified by:

partialReport in interface org.j3d.util.ErrorReporter

Parameters:

msg - The text of the message to be displayed

messageReport

public final void messageReport(String msg)

Notification of an informational message from the system. For example, it may issue a message when a URL cannot be resolved.

Specified by:

messageReport in interface org.j3d.util.ErrorReporter

Parameters:

msg - The text of the message to be displayed

warningReport

public void warningReport(String msg,
 Throwable e)

Notification of a warning in the way the system is currently operating. This is a non-fatal, non-serious error. For example you will get an warning when a value has been set that is out of range.

Specified by:

warningReport in interface org.j3d.util.ErrorReporter

Parameters:

msg - The text of the message to be displayed

e - The exception that caused this warning. May be null

errorReport

public void errorReport(String msg,
 Throwable e)

Notification of a recoverable error. This is a serious, but non-fatal error, for example trying to add a route to a non-existent node or the use of a node that the system cannot find the definition of.

Specified by:

errorReport in interface org.j3d.util.ErrorReporter

Parameters:

msg - The text of the message to be displayed

e - The exception that caused this warning. May be null

fatalErrorReport

public void fatalErrorReport(String msg,
 Throwable e)

Notification of a non-recoverable error that halts the entire system. After you receive this report the runtime system will no longer function - for example a non-recoverable parsing error. The best way out is to reload the file or restart the application internals.

Specified by:

fatalErrorReport in interface org.j3d.util.ErrorReporter

Parameters:

msg - The text of the message to be displayed

e - The exception that caused this warning. May be null

actionPerformed

public void actionPerformed(ActionEvent evt)

Process the action generated from the user interface.

Specified by:

actionPerformed in interface ActionListener

Parameters:

evt - The event that caused this method to be called

redirectSystemMessages

public void redirectSystemMessages()

Redirect system messages to the console.