Package adams.gui.application

Class ChildFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

adams.gui.core.BaseFrame

adams.gui.application.ChildFrame

All Implemented Interfaces:

CleanUpHandler, LoggingSupporter, Child, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class ChildFrame
extends BaseFrame
implements Child

Specialized JFrame class.

Author:

fracpete (fracpete at waikato dot ac dot nz)

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

Modifier and Type	Field	Description
protected boolean	m_DisposeCalled	whether the dispose method has been called already manually.
protected boolean	m_DisposeWindowListenerAdded	whether a window listener to dispose the frame was added.
protected String	m_IconName	the name of the icon to use.
protected String	m_InitialTitle	the initial title.
protected AbstractApplicationFrame	m_Parent	the parent frame.
protected ChildFrame	m_Self	the frame itself.
protected static long	serialVersionUID	for serialization.

Fields inherited from class adams.gui.core.BaseFrame

m_Logger, m_MaximizationFixWindowListener, m_UISettingsApplied, m_UISettingsPrefix, m_UISettingsStored, m_UseMaximizationFix

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
ChildFrame(AbstractApplicationFrame parent, String title)	Constructs a new frame that knows about its parent.
ChildFrame(AbstractApplicationFrame parent, String title, String icon)	Constructs a new frame that knows about its parent.

Method Summary

Modifier and Type	Method	Description
void	addDisposeWindowListener()	Adds a window listener to dispose the frame.
boolean	canCreateNewWindow()	Returns whether a new window, containing the same panel, can be created.
void	cleanUp()	Calls the cleanUp() method if the first component is a CleanUpHandler.
void	dispose()	de-registers the child frame with the parent first.
Logger	getLogger()	Returns the logger.
ChildFrame	getNewWindow()	Creates a new window of itself.
AbstractApplicationFrame	getParentFrame()	returns the parent frame, can be null.
protected void	initGUI()	Initializes the widgets.
protected void	initialize()	Initializes the members.
protected void	performInitialization()	Contains all the initialization steps to perform.
void	setTitle(String title)	Sets the new title.

Methods inherited from class adams.gui.core.BaseFrame

afterHide, afterShow, applyUISettings, beforeHide, beforeShow, finishInit, forName, getUISettingsApplied, getUISettingsPrefix, initializeLogger, isLoggingEnabled, runFrame, setBounds, setLocationRelativeTo, setUISettingsPrefix, setUISettingsPrefix, setVisible, storeUISettings

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

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, 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, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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 adams.gui.application.Child

getTitle, requestFocus, toFront

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

serialVersionUID

protected static final long serialVersionUID

for serialization.

See Also:

Constant Field Values

m_Parent

protected AbstractApplicationFrame m_Parent

the parent frame.

m_Self

protected ChildFrame m_Self

the frame itself.

m_DisposeCalled

protected boolean m_DisposeCalled

whether the dispose method has been called already manually.

m_InitialTitle

protected String m_InitialTitle

the initial title.

m_IconName

protected String m_IconName

the name of the icon to use.

m_DisposeWindowListenerAdded

protected boolean m_DisposeWindowListenerAdded

whether a window listener to dispose the frame was added.

Constructor Detail

ChildFrame

public ChildFrame(AbstractApplicationFrame parent,
                  String title)

Constructs a new frame that knows about its parent.

Parameters:

parent - the parent frame

title - the title of the frame

ChildFrame

public ChildFrame(AbstractApplicationFrame parent,
                  String title,
                  String icon)

Constructs a new frame that knows about its parent.

Parameters:

parent - the parent frame

title - the title of the frame

icon - the name of the icon to use, null to use default

Method Detail

performInitialization

protected void performInitialization()

Contains all the initialization steps to perform.

Overrides:

performInitialization in class BaseFrame

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class BaseFrame

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class BaseFrame

getParentFrame

public AbstractApplicationFrame getParentFrame()

returns the parent frame, can be null.

Specified by:

getParentFrame in interface Child

Returns:

the parent frame

setTitle

public void setTitle(String title)

Sets the new title.

Specified by:

setTitle in interface Child

Overrides:

setTitle in class Frame

Parameters:

title - the new title

cleanUp

public void cleanUp()

Calls the cleanUp() method if the first component is a CleanUpHandler.

Specified by:

cleanUp in interface Child

Specified by:

cleanUp in interface CleanUpHandler

dispose

public void dispose()

de-registers the child frame with the parent first.

Specified by:

dispose in interface Child

Overrides:

dispose in class Window

canCreateNewWindow

public boolean canCreateNewWindow()

Returns whether a new window, containing the same panel, can be created.

Specified by:

canCreateNewWindow in interface Child

Returns:

true if a new window can be created

getNewWindow

public ChildFrame getNewWindow()

Creates a new window of itself.

Specified by:

getNewWindow in interface Child

Returns:

the new window, or null if not possible

addDisposeWindowListener

public void addDisposeWindowListener()

Adds a window listener to dispose the frame.

Specified by:

addDisposeWindowListener in interface Child

getLogger

public Logger getLogger()

Returns the logger.

Specified by:

getLogger in interface Child

Specified by:

getLogger in interface LoggingSupporter

Overrides:

getLogger in class BaseFrame

Returns:

the logger