org.trianacode.gui.windows

Class TrianaWindow

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.trianacode.gui.windows.TrianaWindow

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.ItemListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, FindWordListener

Direct Known Subclasses:

ApplicationFrame, CableColEditor

public abstract class TrianaWindow
extends javax.swing.JFrame
implements java.awt.event.ActionListener, java.awt.event.ItemListener, FindWordListener

Triana Window creates a basic Triana Window with common functionalities and appearance of all Triana Windows. Triana window subclasses a frame and implements a Window and an ActionListener within this class to handle window closed events and some default menu operations.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Frame.AccessibleAWTFrame

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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

Modifier and Type	Field and Description
static java.awt.Font	defaultFont Triana Window's default font : 11 point italic Sans-Serif
FindWordDialog	findWordDialog The find word pop up
protected javax.swing.JMenuBar	trianaMenuBar The JMenuBar for all Triana windows

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, 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 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
TrianaWindow()
TrianaWindow(java.lang.String name) This class provide a basic window with a Window menu containing a close option (which hides the window) and a Help menu which calls the function called help.
TrianaWindow(java.lang.String name, int width, int height) Calls TrianaWindow(String) to initialise the menu's and then resize's to a specific width and height.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Invoked when an action occurs.
void	cleanUp() Called when the user wants to close the window.
void	close() A convenience method to close RMFrames.
abstract java.lang.String	getHelpFile() Purely abstract at this stage.
java.awt.Image	getMyIcon() Returns an image to use as the icon when TrianaWindow is iconified.
java.lang.String	getString(java.lang.String key) Looks in the Resource Bundle (messages) for the text for the key key.
void	itemStateChanged(java.awt.event.ItemEvent e) Does Nothing, just here so we can register as Item listeners
void	refreshMe() Repaints the window by default.
void	setLocation(int x, int y) This overrides the basic setLocation method within component to clip the window so that it always fits on the screen.
void	showFindWordDialog(java.lang.String indexFileName)
void	showHelp() displays the getHelpfile() in a browser.
void	showHelpFor(java.lang.String helpfile) Displays the given help file in a browser.
void	wordFound(FindWordEvent e)
void	writeToFile(java.lang.String name)

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, 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, 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, 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, requestFocusInWindow, 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

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

trianaMenuBar

protected transient javax.swing.JMenuBar trianaMenuBar

The JMenuBar for all Triana windows

defaultFont

public static java.awt.Font defaultFont

Triana Window's default font : 11 point italic Sans-Serif

findWordDialog

public FindWordDialog findWordDialog

The find word pop up

Constructor Detail

TrianaWindow

public TrianaWindow()

TrianaWindow

public TrianaWindow(java.lang.String name)

This class provide a basic window with a Window menu containing a close option (which hides the window) and a Help menu which calls the function called help. Help does nothing at this stage and should be subclassed to provide help.

Note

TrianaWindow does not show (i.e. setVisible(true)) the window. This should be done by the windows inherited from this The window is by default set to be a window in another application.

TrianaWindow

public TrianaWindow(java.lang.String name,
            int width,
            int height)

Calls TrianaWindow(String) to initialise the menu's and then resize's to a specific width and height.

Parameters:

width - the desired width of the window

height - the desired height of the window

Method Detail

getMyIcon

public java.awt.Image getMyIcon()

Returns an image to use as the icon when TrianaWindow is iconified.

Returns:

image to use.

close

public void close()

A convenience method to close RMFrames.

cleanUp

public void cleanUp()

Called when the user wants to close the window. If the window is in another application then the window is just made invisible, but if it is a stand alone application then a really Quit ? window is given to ask the user if he/she really wants to quit or not. TODO refactor this out, it's not needed for all TrianaWindow subclasses

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent e)

Does Nothing, just here so we can register as Item listeners

Specified by:

itemStateChanged in interface java.awt.event.ItemListener

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Invoked when an action occurs.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

writeToFile

public void writeToFile(java.lang.String name)

getString

public java.lang.String getString(java.lang.String key)

Looks in the Resource Bundle (messages) for the text for the key key. If it is found then the text is returned. If not then the function returns a blank string and gives an error message

refreshMe

public void refreshMe()

Repaints the window by default. Override this function to put your window specific refreshing.

setLocation

public void setLocation(int x,
               int y)

This overrides the basic setLocation method within component to clip the window so that it always fits on the screen. If the user enters values which would make some part of the window fall off the end of the screen then the values are alterred accordingly.

Overrides:

setLocation in class java.awt.Window

getHelpFile

public abstract java.lang.String getHelpFile()

Purely abstract at this stage. It's up to the specific windows themselves to return the name of their specific helpFile. If you don't wan't to define help then return "none" otherwise return the help file.

showHelp

public void showHelp()

displays the getHelpfile() in a browser.

showHelpFor

public void showHelpFor(java.lang.String helpfile)

Displays the given help file in a browser. later.

showFindWordDialog

public void showFindWordDialog(java.lang.String indexFileName)

wordFound

public void wordFound(FindWordEvent e)

Specified by:

wordFound in interface FindWordListener