|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
java.awt.Window
java.awt.Dialog
javax.swing.JDialog
com.retek.commons.gui.widget.RDialog
This class sublcasses the standard JDialog class in the Swing package to provide custom functionality for the RCOM Client application. Dialog windows are modal windows that "lock" the system until exited. WindowListener is fully defined so that subclasses only have to implement methods that require functionality.
Retek Inc. Copyright (c) 2002
Nested Class Summary |
Nested classes inherited from class javax.swing.JDialog |
javax.swing.JDialog.AccessibleJDialog |
Nested classes inherited from class java.awt.Dialog |
java.awt.Dialog.AccessibleAWTDialog |
Nested classes inherited from class java.awt.Window |
java.awt.Window.AccessibleAWTWindow |
Nested classes inherited from class java.awt.Container |
java.awt.Container.AccessibleAWTContainer |
Nested classes inherited from class java.awt.Component |
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy |
Field Summary |
Fields inherited from class javax.swing.JDialog |
accessibleContext, rootPane, rootPaneCheckingEnabled |
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, EXIT_ON_CLOSE, HIDE_ON_CLOSE |
Fields inherited from interface java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
RDialog(javax.swing.JDialog dialog)
Returns new RDialog associated with a parent JFrame. |
|
RDialog(javax.swing.JDialog dialog,
boolean modal)
Returns new RDialog associated with a parent JFrame. |
|
RDialog(javax.swing.JFrame frame)
Returns new RDialog associated with a parent JFrame. |
|
RDialog(javax.swing.JFrame frame,
boolean modal)
Returns new RDialog associated with a parent JFrame. |
Method Summary | |
void |
addREventListener(REventListener listener)
Adds a REventListener to the REventListener list. |
void |
centerWindow()
Centers the dialog window within its owner (or parent) window. |
void |
clearAllExceptions()
Clears the exceptions in the widget manager. |
void |
clearBusinessExceptions()
Clears the business exceptions in the widget manager. |
void |
clearStatusBar()
Clears the status bar. |
void |
clearUIExceptions()
Clears the UI exceptions in the widget manager. |
void |
clearWidgetHistory()
Clears the widget history. |
void |
displayException(BusinessException exception)
Displays a Business exception on the status bar. |
void |
displayException(ConcurrentUpdateException exception)
Displays a ConcurrentUpdateException in a fatal window. |
void |
displayException(RErrorEvent event)
Displays a RErrorEvent exception on the status bar. |
void |
displayException(java.lang.RuntimeException exception)
Displays a runtime severe exception in the fatal window and then closes the dialog. |
void |
displayException(SystemException exception)
Displays a System exception in a fatal window. |
void |
displayException(java.lang.Throwable throwable)
Displays an exception in the appropriate manner. |
void |
displayException(UiBusinessException exception)
Displays a GUI exception on the status bar. |
void |
displayMessage(java.lang.String message)
Displays a message in the status bar (defaults to ErrorSeverity.INFO); |
void |
displaySearchMessage(java.lang.String message)
Displays a message in the status bar (defaults to ErrorSeverity.INFO) and sends the status bar into searching mode. |
protected void |
displaySearchMessage(java.lang.String message,
java.lang.String valueOne)
Displays a message in the status bar (defaults to ErrorSeverity.INFO) and sends the status bar into searching mode. |
void |
displayWarning(java.lang.String warning)
Displays a message in the status bar (defaults to ErrorSeverity.INFO); |
protected RetekLogger |
getLogger()
Retrieves the logger object to be used for this dialog window. |
RStatusBar |
getStatusBar()
Retrieves the status bar. |
WidgetManager |
getWidgetManager()
Retrieves the widget manager for this dialog window. |
boolean |
hasAnyExceptions()
Returns whether or not the widget manager has any widgets that have errors. |
boolean |
hasBusinessExceptions()
Returns whether or not the widget manager has any business exceptions in memory. |
boolean |
hasUIExceptions()
Returns whether or not the widget manager has any widgets that have errors. |
void |
indentWindow(java.awt.Window parent,
int indent)
Idents this window within another window from both the top and left side of the parent window. |
boolean |
isDialogModified()
Retrieves whether or not the dialog contents have been modified. |
protected void |
logDebug(java.lang.String message)
Displays a debut message. |
void |
notifyREventListeners(RActionEvent event)
Notifies all listeners of an action event. |
void |
notifyREventListeners(RErrorEvent event)
Notifies all listeners of an error event. |
void |
performActionEvent(RActionEvent event)
Implements the required REventListener method. |
void |
performErrorEvent(RErrorEvent event)
Implements the required REventListener method. |
protected void |
recover()
Called after a system error to recover the state of the application. |
void |
releaseWidget(java.lang.String widgetName)
Releases a widget from error state based on a widget name. |
void |
removeAllREventListeners()
Removes a REventListener from the REventListener list. |
void |
removeREventListener(REventListener listener)
Removes a REventListener from the REventListener list. |
void |
setActionsEnabled(boolean enabled)
Sets whether or not the widget manager should send actions. |
void |
setDialogModified(boolean modified)
Sets the manager state of the dialog to modified (meaning widgets values are considered altered. |
void |
setMonitorEnabled(boolean enabled)
Enables or disables the monitor part of the widget manager that tracks the modification of widget contents. |
void |
setTitle(java.lang.String title)
Sets the title of the window. |
void |
windowActivated(java.awt.event.WindowEvent event)
Implements default window listener interface 'window activated' method. |
void |
windowClosed(java.awt.event.WindowEvent event)
Implements default window listener interface 'window closed' method. |
void |
windowClosing(java.awt.event.WindowEvent event)
Implements default window listener interface 'window opened' method. |
void |
windowDeactivated(java.awt.event.WindowEvent event)
Implements default window listener interface 'window deactivated' method. |
void |
windowDeiconified(java.awt.event.WindowEvent event)
Implements default window listener interface 'window deiconified' method. |
void |
windowIconified(java.awt.event.WindowEvent event)
Implements default window listener interface 'window iconified' method. |
void |
windowOpened(java.awt.event.WindowEvent event)
Implements default window listener interface 'window opened' method. |
Methods inherited from class javax.swing.JDialog |
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update |
Methods inherited from class java.awt.Dialog |
addNotify, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setUndecorated, show |
Methods inherited from class java.awt.Window |
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, isOpaque, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public RDialog(javax.swing.JFrame frame)
frame
- The owner to associate this dialog box with.public RDialog(javax.swing.JFrame frame, boolean modal)
frame
- The owner to associate this dialog box with.public RDialog(javax.swing.JDialog dialog)
dialog
- The owner to associated this dialog box with.public RDialog(javax.swing.JDialog dialog, boolean modal)
dialog
- The owner to associated this dialog box with.Method Detail |
public void setTitle(java.lang.String title)
title
- The title to set in the window.public void centerWindow()
public void indentWindow(java.awt.Window parent, int indent)
parent
- The window to calculate the indentation from.indent
- The number of pixels to indent.public void addREventListener(REventListener listener)
listener
- The REventListener to add.public void removeREventListener(REventListener listener)
listener
- The REventListener to remove.public void removeAllREventListeners()
public void notifyREventListeners(RActionEvent event)
event
- An RActionEvent.public void notifyREventListeners(RErrorEvent event)
event
- An RErrorEvent.public void performActionEvent(RActionEvent event)
performActionEvent
in interface REventListener
event
- The RActionEvent that triggered this listener method.public void performErrorEvent(RErrorEvent event)
performErrorEvent
in interface REventListener
event
- The RErrorEvent that triggered this listener method.public void windowIconified(java.awt.event.WindowEvent event)
windowIconified
in interface java.awt.event.WindowListener
event
- Details about the window event that occurred.public void windowDeiconified(java.awt.event.WindowEvent event)
windowDeiconified
in interface java.awt.event.WindowListener
event
- Details about the window event that occurred.public void windowActivated(java.awt.event.WindowEvent event)
windowActivated
in interface java.awt.event.WindowListener
event
- Details about the window event that occurred.public void windowDeactivated(java.awt.event.WindowEvent event)
windowDeactivated
in interface java.awt.event.WindowListener
event
- Details about the window event that occurred.public void windowClosed(java.awt.event.WindowEvent event)
windowClosed
in interface java.awt.event.WindowListener
event
- Details about the window event that occurred.public void windowOpened(java.awt.event.WindowEvent event)
windowOpened
in interface java.awt.event.WindowListener
event
- Details about the window event that occurred.public void windowClosing(java.awt.event.WindowEvent event)
windowClosing
in interface java.awt.event.WindowListener
event
- Details about the window event that occurred.protected void recover()
public RStatusBar getStatusBar()
public void clearStatusBar()
public WidgetManager getWidgetManager()
protected RetekLogger getLogger()
protected void logDebug(java.lang.String message)
message
- The message for the logger to display.public void setActionsEnabled(boolean enabled)
public void setMonitorEnabled(boolean enabled)
enabled
- True if the monitor should be active, false if not.public void setDialogModified(boolean modified)
modified
- True if the dialog is considered modified, false if not.public boolean isDialogModified()
public void clearAllExceptions()
public void clearBusinessExceptions()
public void clearUIExceptions()
public void clearWidgetHistory()
public boolean hasAnyExceptions()
public boolean hasBusinessExceptions()
public boolean hasUIExceptions()
public void releaseWidget(java.lang.String widgetName)
widgetName
- The widget name.public void displayException(java.lang.Throwable throwable)
throwable
- An throwable exception.public void displayMessage(java.lang.String message)
message
- A message code to translate and display.public void displaySearchMessage(java.lang.String message)
message
- A message code to translate and display.protected void displaySearchMessage(java.lang.String message, java.lang.String valueOne)
message
- A message code to translate and display.valueOne
- A fill-in value for messagepublic void displayWarning(java.lang.String warning)
public void displayException(RErrorEvent event)
public void displayException(BusinessException exception)
exception
- A BusinessExcpetion (or sub-class thereof).public void displayException(UiBusinessException exception)
exception
- A UiException (or sub-class thereof).public void displayException(SystemException exception)
exception
- A System Exception (or sub-class thereof).public void displayException(ConcurrentUpdateException exception)
exception
- A System Exception (or sub-class thereof).public void displayException(java.lang.RuntimeException exception)
exception
- A Runtime Exception (or sub-class thereof).
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |