public abstract class XalInternalWindow extends javax.swing.JInternalFrame implements XalDocumentView, XalInternalDocumentListener
javax.swing.JInternalFrame.AccessibleJInternalFrame, javax.swing.JInternalFrame.JDesktopIcon
javax.swing.JComponent.AccessibleJComponent
Modifier and Type | Field and Description |
---|---|
protected XalInternalDocument |
_document
The document corresponding to this main window
|
static int |
NO_OPTION |
static int |
YES_OPTION |
closable, CONTENT_PANE_PROPERTY, desktopIcon, FRAME_ICON_PROPERTY, frameIcon, GLASS_PANE_PROPERTY, iconable, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, isClosed, isIcon, isMaximum, isSelected, LAYERED_PANE_PROPERTY, maximizable, MENU_BAR_PROPERTY, resizable, ROOT_PANE_PROPERTY, rootPane, rootPaneCheckingEnabled, title, TITLE_PROPERTY
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Constructor and Description |
---|
XalInternalWindow(XalInternalDocument aDocument)
Creates a new instance of WindowAdaptor
|
Modifier and Type | Method and Description |
---|---|
void |
captureAsImage()
Capture the window content as a PNG.
|
void |
closeWindow()
Close this window.
|
void |
customizeCommands(Commander commander)
Override this method to register custom commands.
|
int |
displayConfirmDialog(java.lang.String title,
java.lang.String message)
Display a confirmation dialog with a title and message
|
void |
displayError(java.lang.Exception exception)
Display an error dialog box with information about the exception and
provide an audible alert.
|
void |
displayError(java.lang.String aTitle,
java.lang.String message)
Display an error dialog box and provide an audible alert.
|
void |
displayError(java.lang.String aTitle,
java.lang.String prefix,
java.lang.Exception exception)
Display an error dialog box with information about the exception and
provide an audible alert.
|
void |
displayWarning(java.lang.Exception exception)
Display a warning dialog box showing information about an exception that
has been thrown and provide an audible alert.
|
void |
displayWarning(java.lang.String aTitle,
java.lang.String message)
Display a warning dialog box and provide an audible alert.
|
void |
displayWarning(java.lang.String aTitle,
java.lang.String prefix,
java.lang.Exception exception)
Display a warning dialog box with information about the exception and provide
an audible alert.
|
void |
documentActivated(XalInternalDocument document)
Handle the document activated event.
|
void |
documentDeactivated(XalInternalDocument document)
Handle the document activated event.
|
void |
documentHasClosed(XalInternalDocument document)
Handle document closed event.
|
void |
documentWillClose(XalInternalDocument document)
Handle the event indicating that the document will close by closing the window in response.
|
void |
freeCustomResources()
Dispose of custom window resources.
|
void |
generateWindowTitle()
Generate the title on the title bar to reflect the document state.
|
javax.swing.JToolBar |
getToolBar()
Get the toolbar associated with this window.
|
void |
hasChangesChanged(XalInternalDocument document,
boolean newHasChangesStatus)
Update the title on the title bar to reflect whether the document has changes that need saving.
|
void |
hideWindow()
Iconify this window.
|
Commander |
makeCommander()
Subclasses should override this method to provide a custom Commander.
|
void |
makeFrame()
Make the frame and populate the menubar and toolbar.
|
void |
registerEvents()
Register the event handlers
|
void |
releaseWindow()
Dispose of this window and remove its association with the document.
|
void |
showWindow()
Show this window.
|
void |
titleChanged(XalInternalDocument document,
java.lang.String documentTitle)
Handle the document event indicating that the title has changed.
|
boolean |
userPermitsCloseWithUnsavedChanges()
Query the user to see if it is okay to close the document given that unsaved changes exist.
|
boolean |
usesToolbar()
Subclasses may override this method to create a toolbar.
|
addImpl, addInternalFrameListener, createRootPane, dispose, doDefaultCloseAction, fireInternalFrameEvent, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLastCursor, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isRootPaneCheckingEnabled, isSelected, moveToBack, moveToFront, pack, paintComponent, paramString, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setCursor, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setRootPane, setRootPaneCheckingEnabled, setSelected, setTitle, setUI, show, toBack, toFront, updateUI
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getJMenuBar, getLocation, getLocationOnScreen, isVisible, setJMenuBar, setLocation, setVisible
public static final int YES_OPTION
public static final int NO_OPTION
protected XalInternalDocument _document
public XalInternalWindow(XalInternalDocument aDocument)
public void registerEvents()
public void makeFrame()
public Commander makeCommander()
public javax.swing.JToolBar getToolBar()
getToolBar
in interface XalDocumentView
public void customizeCommands(Commander commander)
public void closeWindow()
public void captureAsImage()
captureAsImage
in interface XalDocumentView
public void showWindow()
showWindow
in interface XalDocumentView
public void hideWindow()
hideWindow
in interface XalDocumentView
public boolean userPermitsCloseWithUnsavedChanges()
public final void releaseWindow()
public void freeCustomResources()
public void generateWindowTitle()
public final void titleChanged(XalInternalDocument document, java.lang.String documentTitle)
titleChanged
in interface XalInternalDocumentListener
document
- The document initiating the title changed event.documentTitle
- The new document title.public void hasChangesChanged(XalInternalDocument document, boolean newHasChangesStatus)
hasChangesChanged
in interface XalInternalDocumentListener
document
- The document initiating the event.newHasChangesStatus
- The new status identifying whethe the document has changes to be savedtitleChanged(xal.extension.application.XalInternalDocument, java.lang.String)
public void documentWillClose(XalInternalDocument document)
documentWillClose
in interface XalInternalDocumentListener
document
- The document that will close.public void documentHasClosed(XalInternalDocument document)
documentHasClosed
in interface XalInternalDocumentListener
document
- The document that has closed.public void documentActivated(XalInternalDocument document)
documentActivated
in interface XalInternalDocumentListener
document
- the document that has been activated.public void documentDeactivated(XalInternalDocument document)
documentDeactivated
in interface XalInternalDocumentListener
document
- the document that has been activated.public boolean usesToolbar()
public int displayConfirmDialog(java.lang.String title, java.lang.String message)
displayConfirmDialog
in interface XalDocumentView
title
- The title of the dialogmessage
- The message to displaypublic void displayWarning(java.lang.String aTitle, java.lang.String message)
displayWarning
in interface XalDocumentView
aTitle
- Title of the warning dialog box.message
- The warning message to appear in the warning dialog box.public void displayWarning(java.lang.Exception exception)
displayWarning
in interface XalDocumentView
exception
- The exception whose description is being displayed.public void displayWarning(java.lang.String aTitle, java.lang.String prefix, java.lang.Exception exception)
displayWarning
in interface XalDocumentView
aTitle
- Title of the warning dialog box.prefix
- Text that should appear in the dialog box before the exception messasge.exception
- The exception about which the warning dialog is displayed.public void displayError(java.lang.String aTitle, java.lang.String message)
displayError
in interface XalDocumentView
aTitle
- Title of the warning dialog box.message
- The warning message to appear in the warning dialog box.public void displayError(java.lang.Exception exception)
displayError
in interface XalDocumentView
exception
- The exception about which the warning dialog is displayed.public void displayError(java.lang.String aTitle, java.lang.String prefix, java.lang.Exception exception)
displayError
in interface XalDocumentView
aTitle
- Title of the warning dialog box.prefix
- Text that should appear in the dialog box before the exception messasge.exception
- The exception about which the warning dialog is displayed.