Package ca.phon.ui
Class CommonModuleFrame
java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Window
java.awt.Frame
javax.swing.JFrame
ca.phon.ui.CommonModuleFrame
- All Implemented Interfaces:
IExtendable
,ImageObserver
,MenuContainer
,Serializable
,Accessible
,RootPaneContainer
,WindowConstants
- Direct Known Subclasses:
BufferWindow
,IpaMapFrame
,LogViewer
,OpgraphEditor
,ProjectFrame
,ProjectParticpantsWindow
,ProjectWindow
,ReportTableExportDialog
,ReportTreeToHTMLDialog
,SimpleEditor
,WelcomeWindow
,WizardFrame
The common class for a gui window
- See Also:
-
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
Modifier and TypeFieldDescriptionstatic final boolean
static final String
Property to enable fullscreen on macosprotected String
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
ConstructorDescriptionCreates a new CommonModuleFrameCommonModuleFrame
(String title) Creates a new CommonModuleFrame -
Method Summary
Modifier and TypeMethodDescriptionstatic void
addNewWindowListener
(Object weakKey, CommonModuleFrameCreatedListener listener) Add a new window create listener to the list of static listeners.void
cascadeWindow
(JFrame frame) void
Center the window in the middle of the display.void
close()
void
display()
static CommonModuleFrame
<T> T
getExtension
(Class<T> cap) Get the requested extension if available.Return all extension types supportedstatic List<CommonModuleFrame>
static Map<Project,
List<CommonModuleFrame>> Return a map of projects and open windows for each project.getTitle()
Overridden to provide consistent naming in all windows.Get window nameboolean
Does this window have un-saved changes?void
boolean
void
Places window in top-right corner of screen.void
positionRelativeTo
(int boxSide, int position, CommonModuleFrame component) Position the window relative to another window using the boxSize and position parameters.<T> T
putExtension
(Class<T> cap, T impl) Add a new extension.<T> T
removeExtension
(Class<T> cap) Remove a capability.void
void
Save data and close window if save was successful.boolean
saveData()
Save window changesvoid
setModified
(boolean modified) void
setParentFrame
(CommonModuleFrame frame) void
setShowInWindowMenu
(boolean showInWindowMenu) void
setUnsavedChangesMessage
(String message) void
setUnsavedChangesTitle
(String title) void
setWindowName
(String name) Set window namevoid
showErrorMessage
(String message) int
showMessageDialog
(String title, String message, String[] options) Display a message dialog to the user positioned for this window.int
showOkCancelDialog
(String title, String message) void
showOkDialog
(String title, String message) void
showStatusMessage
(String message) int
showYesNoCancelDialog
(String title, String message) int
showYesNoDialog
(String title, String message) 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, 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
-
Field Details
-
MACOS_ENABLE_FULLSCREEN
Property to enable fullscreen on macos- See Also:
-
DEFAULT_MACOS_ENABLE_FULLSCREEN
public static final boolean DEFAULT_MACOS_ENABLE_FULLSCREEN- See Also:
-
title
-
-
Constructor Details
-
CommonModuleFrame
public CommonModuleFrame()Creates a new CommonModuleFrame -
CommonModuleFrame
Creates a new CommonModuleFrame- Parameters:
title
- the title string for the frame
-
-
Method Details
-
addNewWindowListener
Add a new window create listener to the list of static listeners. The weak key is used to determine when the listener should be removed from the listener queue.- Parameters:
weakKey
-listener
-
-
getOpenWindows
-
getProjectWindows
Return a map of projects and open windows for each project.- Returns:
- project window map
-
getCurrentFrame
-
getUnsavedChangesTitle
-
setUnsavedChangesTitle
-
getUnsavedChangesMessage
-
setUnsavedChangesMessage
-
close
public void close() -
getTitle
Overridden to provide consistent naming in all windows. Use setWindowName() to setup the custom name for the window. -
setWindowName
Set window name -
getWindowName
Get window name -
display
public void display() -
getParentFrame
-
setParentFrame
-
isShowInWindowMenu
public boolean isShowInWindowMenu() -
setShowInWindowMenu
public void setShowInWindowMenu(boolean showInWindowMenu) -
centerWindow
public void centerWindow()Center the window in the middle of the display. If size is not defined preferred size is used. If the window has already been realized, it will not be resized. -
cascadeWindow
-
placeTopRight
public void placeTopRight()Places window in top-right corner of screen. -
showOkDialog
-
showOkCancelDialog
-
showYesNoDialog
-
showYesNoCancelDialog
-
showMessageDialog
Display a message dialog to the user positioned for this window.- Parameters:
title
-message
-options
- list of options displayed to the user- Returns:
- the selected option
-
showStatusMessage
-
showErrorMessage
-
hideStatusComponent
public void hideStatusComponent() -
resetStatusComponent
public void resetStatusComponent() -
hasUnsavedChanges
public boolean hasUnsavedChanges()Does this window have un-saved changes?- Returns:
- true if this window has un-saved changes
-
setModified
public void setModified(boolean modified) -
saveAndClose
public void saveAndClose()Save data and close window if save was successful. -
saveData
Save window changes- Throws:
IOException
-
positionRelativeTo
Position the window relative to another window using the boxSize and position parameters.- Parameters:
boxSide
- one of SwingConstants.TOP,BOTTOM,RIGHT,LEFT. The window will be positioned on this side of the given window.position
- one of SwingConstants.LEADING,CENTER,TRAILING. The window will be positioned using standard left-to-right, top-to-bottom positioning based on this parameter.parentFrame
- . The frame to use as the anchor.- Throws:
IllegalArgumentException
- if boxSize or position are not one of the accept values.
-
getExtensions
Description copied from interface:IExtendable
Return all extension types supported- Specified by:
getExtensions
in interfaceIExtendable
-
getExtension
Description copied from interface:IExtendable
Get the requested extension if available.- Specified by:
getExtension
in interfaceIExtendable
- Returns:
- the capability object or
null
if the cability is not available
-
putExtension
Description copied from interface:IExtendable
Add a new extension.- Specified by:
putExtension
in interfaceIExtendable
- Parameters:
cap
- the extension to add- Returns:
- the added extension implementation
-
removeExtension
Description copied from interface:IExtendable
Remove a capability.- Specified by:
removeExtension
in interfaceIExtendable
- Parameters:
cap
- the capability to remove
-