com.retek.commons.gui.widget
Class RFrame

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Frame
                  extended byjavax.swing.JFrame
                      extended bycom.retek.commons.gui.widget.RFrame
All Implemented Interfaces:
javax.accessibility.Accessible, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, REventListener, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants, java.awt.event.WindowListener
Direct Known Subclasses:
ApplicationFrame, ItemFrame, PersonalReminderDialog, RmmApplicationFrame, UpsellFrame, WorkListDialog

public abstract class RFrame
extends javax.swing.JFrame
implements java.awt.event.WindowListener, REventListener

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JFrame
javax.swing.JFrame.AccessibleJFrame
 
Nested classes inherited from class java.awt.Frame
java.awt.Frame.AccessibleAWTFrame
 
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.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
RFrame()
          Constructs new RFrame object.
 
Method Summary
 void addREventListener(REventListener listener)
          Adds a REventListener to the REventListener list.
 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.
protected  void displayException(BusinessException exception)
          Displays a Business exception on the status bar.
 void displayException(BusinessException exception, RetekLogger logger)
          Displays a Business Exception on the status bar.
protected  void displayException(ConcurrentUpdateException exception)
          Displays a ConcurrentUpdateException.
 void displayException(RErrorEvent event, RetekLogger logger)
          Displays a RErrorEvent exception on the status bar.
 void displayException(java.lang.RuntimeException exception, RetekLogger logger)
          Displays a System exception in a fatal window.
 void displayException(SystemException exception, RetekLogger logger)
          Displays a System exception in a fatal window.
 void displayException(java.lang.Throwable throwable)
          Displays an exception.
 void displayException(java.lang.Throwable throwable, RetekLogger logger)
          Displays an exception.
protected  void displayException(UiBusinessException exception)
          Displays a GUI exception on the status bar.
 void displayException(UiBusinessException exception, RetekLogger logger)
          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 displayMessage(java.lang.String message, RetekLogger logger)
          Displays a message in the status bar (defaults to ErrorSeverity.INFO);
 void displaySearchMessage(java.lang.String message, ErrorSeverity severity)
          Displays a search message in the status bar (defaults to ErrorSeverity.INFO);
 void displayWarning(java.lang.String warning, RetekLogger logger)
          Displays a message in the status bar (defaults to ErrorSeverity.INFO);
protected  RetekLogger getLogger()
          Retrieves the logger object to be used for this frame();
 RStatusBar getStatusBar()
          Retrieves the status bar associated with the frame.
 WidgetManager getWidgetManager()
          Retrieves the widget manager for this 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.
 boolean isFrameModified()
          Retrieves whether or not the frame contents have been modified.
 void maximize()
          Resizes window to screen size minus the task bar at the bottem.
 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.
 void pushQueue(java.awt.EventQueue queue)
          Pushes another event queue on the system even queue being used by this frame.
abstract  void recover()
          Called by the fatal dialog window after a fatal error has occurred.
 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 setFrameModified(boolean modified)
          Sets the manager state of the frame 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 show()
          Makes the Window visible.
 void windowActivated(java.awt.event.WindowEvent event)
          Empty implementation to satisfy the WindowListener interface.
 void windowClosed(java.awt.event.WindowEvent event)
          Implements the WindowListener method to call close window.
 void windowClosing(java.awt.event.WindowEvent event)
          Implements the WindowListener method to call close window.
 void windowDeactivated(java.awt.event.WindowEvent event)
          Empty implementation to satisfy the WindowListener interface.
 void windowDeiconified(java.awt.event.WindowEvent event)
          Displays all sub-windows when the main background screen is de-iconified.
 void windowIconified(java.awt.event.WindowEvent event)
          Hides all sub-windows when the main background screen is iconified.
 void windowOpened(java.awt.event.WindowEvent event)
          Empty implementation to satisfy the WindowListener interface.
 
Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, 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.Frame
addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, 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, 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, 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
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Constructor Detail

RFrame

public RFrame()
Constructs new RFrame object.

Method Detail

maximize

public void maximize()
Resizes window to screen size minus the task bar at the bottem. This method will cause the frame to appear if it is not visible or resize to the correct size if it is visible.


getLogger

protected RetekLogger getLogger()
Retrieves the logger object to be used for this frame();

Returns:
The logger object.

getWidgetManager

public WidgetManager getWidgetManager()
Retrieves the widget manager for this window.

Returns:
The widget manager for the window.

setActionsEnabled

public void setActionsEnabled(boolean enabled)
Sets whether or not the widget manager should send actions.

Returns:
True if a the widget manager should send actions, false if not.

setMonitorEnabled

public void setMonitorEnabled(boolean enabled)
Enables or disables the monitor part of the widget manager that tracks the modification of widget contents.

Parameters:
enabled - True if the monitor should be active, false if not.

setFrameModified

public void setFrameModified(boolean modified)
Sets the manager state of the frame to modified (meaning widgets values are considered altered.

Parameters:
modified - True if the frame is considered modified, false if not.

isFrameModified

public boolean isFrameModified()
Retrieves whether or not the frame contents have been modified.

Returns:
True if a widget value has been modified in the manager, false if not.

clearAllExceptions

public void clearAllExceptions()
Clears the exceptions in the widget manager.


clearBusinessExceptions

public void clearBusinessExceptions()
Clears the business exceptions in the widget manager.


clearUIExceptions

public void clearUIExceptions()
Clears the UI exceptions in the widget manager.


clearWidgetHistory

public void clearWidgetHistory()
Clears the widget history. Resets the last value of widgets to empty.


hasAnyExceptions

public boolean hasAnyExceptions()
Returns whether or not the widget manager has any widgets that have errors.

Returns:
True if a the widget manager currently contains errors, false if not.

hasBusinessExceptions

public boolean hasBusinessExceptions()
Returns whether or not the widget manager has any business exceptions in memory.

Returns:
True if a the widget manager currently contains business exceptions, false if not.

hasUIExceptions

public boolean hasUIExceptions()
Returns whether or not the widget manager has any widgets that have errors.

Returns:
True if a the widget manager currently contains UI business exceptions, false if not.

releaseWidget

public void releaseWidget(java.lang.String widgetName)
Releases a widget from error state based on a widget name.

Parameters:
widgetName - The widget name.

displayException

protected void displayException(BusinessException exception)
Displays a Business exception on the status bar.

Parameters:
exception - A BusinessExcpetion (or sub-class thereof).

displayException

protected void displayException(UiBusinessException exception)
Displays a GUI exception on the status bar.

Parameters:
exception - A UiException (or sub-class thereof).

pushQueue

public void pushQueue(java.awt.EventQueue queue)
Pushes another event queue on the system even queue being used by this frame.

Parameters:
queue - The queue to push on the event queue.

addREventListener

public void addREventListener(REventListener listener)
Adds a REventListener to the REventListener list.

Parameters:
listener - The REventListener to add.

removeREventListener

public void removeREventListener(REventListener listener)
Removes a REventListener from the REventListener list.

Parameters:
listener - The REventListener to remove.

removeAllREventListeners

public void removeAllREventListeners()
Removes a REventListener from the REventListener list.


notifyREventListeners

public void notifyREventListeners(RActionEvent event)
Notifies all listeners of an action event.

Parameters:
event - An RActionEvent.

notifyREventListeners

public void notifyREventListeners(RErrorEvent event)
Notifies all listeners of an error event.

Parameters:
event - An RErrorEvent.

performActionEvent

public void performActionEvent(RActionEvent event)
Implements the required REventListener method. It sends the event to all current REventListeners of the panel.

Specified by:
performActionEvent in interface REventListener
Parameters:
event - The RActionEvent that triggered this listener method.

performErrorEvent

public void performErrorEvent(RErrorEvent event)
Implements the required REventListener method. It sends the event to all current REventListeners of the panel.

Specified by:
performErrorEvent in interface REventListener
Parameters:
event - The RErrorEvent that triggered this listener method.

windowActivated

public void windowActivated(java.awt.event.WindowEvent event)
Empty implementation to satisfy the WindowListener interface.

Specified by:
windowActivated in interface java.awt.event.WindowListener

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent event)
Empty implementation to satisfy the WindowListener interface.

Specified by:
windowDeactivated in interface java.awt.event.WindowListener

windowClosed

public void windowClosed(java.awt.event.WindowEvent event)
Implements the WindowListener method to call close window.

Specified by:
windowClosed in interface java.awt.event.WindowListener

windowClosing

public void windowClosing(java.awt.event.WindowEvent event)
Implements the WindowListener method to call close window.

Specified by:
windowClosing in interface java.awt.event.WindowListener

windowIconified

public void windowIconified(java.awt.event.WindowEvent event)
Hides all sub-windows when the main background screen is iconified.

Specified by:
windowIconified in interface java.awt.event.WindowListener

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent event)
Displays all sub-windows when the main background screen is de-iconified.

Specified by:
windowDeiconified in interface java.awt.event.WindowListener

windowOpened

public void windowOpened(java.awt.event.WindowEvent event)
Empty implementation to satisfy the WindowListener interface.

Specified by:
windowOpened in interface java.awt.event.WindowListener

show

public void show()
Makes the Window visible. If the Window is already visible and or minimized, this will bring the Window to the front.


getStatusBar

public RStatusBar getStatusBar()
Retrieves the status bar associated with the frame.

Returns:
The status bar associated with the frame.

clearStatusBar

public void clearStatusBar()
Clears the status bar.


displayException

public void displayException(java.lang.Throwable throwable,
                             RetekLogger logger)
Displays an exception. This checks which of the exception the throwable is and calls the appropriate displayException() method.

Parameters:
throwable - A throwable exception.

displayException

public void displayException(java.lang.Throwable throwable)
Displays an exception. This checks which of the exception the throwable is and calls the appropriate displayException() method.

Parameters:
throwable - A throwable exception.

displayMessage

public void displayMessage(java.lang.String message,
                           RetekLogger logger)
Displays a message in the status bar (defaults to ErrorSeverity.INFO);

Parameters:
message - A message code to translate and display.

displayMessage

public void displayMessage(java.lang.String message)
Displays a message in the status bar (defaults to ErrorSeverity.INFO);

Parameters:
message - A message code to translate and display.

displaySearchMessage

public void displaySearchMessage(java.lang.String message,
                                 ErrorSeverity severity)
Displays a search message in the status bar (defaults to ErrorSeverity.INFO);

Parameters:
message - A message code to translate and display.
severity - The error severity.

displayWarning

public void displayWarning(java.lang.String warning,
                           RetekLogger logger)
Displays a message in the status bar (defaults to ErrorSeverity.INFO);


displayException

public void displayException(RErrorEvent event,
                             RetekLogger logger)
Displays a RErrorEvent exception on the status bar.


displayException

public void displayException(BusinessException exception,
                             RetekLogger logger)
Displays a Business Exception on the status bar.

Parameters:
exception - A BusinessException (or sub-class thereof).

displayException

public void displayException(UiBusinessException exception,
                             RetekLogger logger)
Displays a GUI exception on the status bar.

Parameters:
exception - A UiException (or sub-class thereof).

displayException

public void displayException(SystemException exception,
                             RetekLogger logger)
Displays a System exception in a fatal window.

Parameters:
exception - A System Exception (or sub-class thereof).

displayException

protected void displayException(ConcurrentUpdateException exception)
Displays a ConcurrentUpdateException.

Parameters:
exception - A System Exception (or sub-class thereof).

displayException

public void displayException(java.lang.RuntimeException exception,
                             RetekLogger logger)
Displays a System exception in a fatal window.

Parameters:
exception - A System Exception (or sub-class thereof).

recover

public abstract void recover()
Called by the fatal dialog window after a fatal error has occurred.



Copyright © 2004 Retek Inc. All Rights Reserved. - Generated at Fri, 10/22/2004 07:28