com.retek.commons.gui.widget
Class RScreen

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended bycom.retek.commons.gui.widget.RPanel
                      extended bycom.retek.commons.gui.widget.RScreen
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, REventListener, java.io.Serializable

public abstract class RScreen
extends RPanel

This class is a panel with screen-like functionality. It is the superclass of all screens that need to be swapped in the main background frame. In other words, they are the superclass of all primary tabs.

Retek Inc. Copyright (c) 2002

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
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.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
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
 
Constructor Summary
RScreen()
          Returns new RScreen object.
 
Method Summary
 void clearAllExceptions()
          Clears the exceptions in the widget manager.
 void clearBusinessExceptions()
          Clears the business exceptions in the widget manager.
protected  void clearStatusBar()
          Clears the status bar.
 void clearUIExceptions()
          Clears the UI exceptions in the widget manager.
 void displayException(BusinessException exception, RetekLogger logger)
          Displays a Business Exception.
protected abstract  void displayException(ConcurrentUpdateException exception)
           
protected abstract  void displayException(java.lang.RuntimeException exception)
           
protected abstract  void displayException(SystemException exception)
           
protected  void displayException(java.lang.Throwable throwable)
          Displays an exception.
 void displayException(UiBusinessException exception, RetekLogger logger)
          Displays a UIBusinessException.
protected abstract  void displayMessage(java.lang.String message)
           
protected abstract  void displaySearchMessage(java.lang.String message, ErrorSeverity severity)
          Abstract methods for displaying exceptions.
protected abstract  void displayWarning(java.lang.String warning)
           
protected  RetekLogger getLogger()
          Retrieves the logger object to be used for this dialog window.
 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.
 boolean isScreenModified()
          Retrieves whether or not the widget values have been altered.
protected  void logDebug(java.lang.String message)
          Displays a debut message.
protected  void releaseWidget(java.lang.String widgetName)
          Clears a single widgets of errors, releasing it from error state and removing its error message.
 void setActionsEnabled(boolean enabled)
          Sets whether or not the widget manager should send actions.
 void setMonitorEnabled(boolean enabled)
          Enables or disables the monitor part of the widget manager that tracks the modification of widget contents.
 void setNavigationEnabled(boolean enabled)
          Enables or disables the navigation functionality of the widget manager.
 void setScreenModified(boolean modified)
          Sets the state of the screen indicating if the contents have been altered or not.
protected  void setStatusBar(RStatusBar statusBar)
          Sets the status bar for this screen.
 
Methods inherited from class com.retek.commons.gui.widget.RPanel
addREventListener, getFocusCycleComponents, notifyREventListeners, notifyREventListeners, performActionEvent, performErrorEvent, removeAllREventListeners, removeREventListener, repaintPanel, setEmptyBorder, setEmptyBorder, setFocusCycleComponents, setLineBorder, setLineBorder, setLoweredBevelBorder, setMinimumHeight, setRaisedBevelBorder, setTitleBorder, setTitleBorder, setTitleBorder, setTitleBorder
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RScreen

public RScreen()
Returns new RScreen object.

Method Detail

getWidgetManager

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

Returns:
The widget manager.

getLogger

protected RetekLogger getLogger()
Retrieves the logger object to be used for this dialog window.

Returns:
The logger object.

logDebug

protected void logDebug(java.lang.String message)
Displays a debut message.

Parameters:
message - The message for the logger to display.

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.

setNavigationEnabled

public void setNavigationEnabled(boolean enabled)
Enables or disables the navigation functionality of the widget manager. If true, the widget manager will send out all navigation keystrokes as actions.

Parameters:
enabled - True if the navigation should be enabled, 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.

setScreenModified

public void setScreenModified(boolean modified)
Sets the state of the screen indicating if the contents have been altered or not.


isScreenModified

public boolean isScreenModified()
Retrieves whether or not the widget values have been altered.

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.


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

protected void releaseWidget(java.lang.String widgetName)
Clears a single widgets of errors, releasing it from error state and removing its error message.

Parameters:
widgetName - The widget name of the component to clear.

setStatusBar

protected void setStatusBar(RStatusBar statusBar)
Sets the status bar for this screen.


clearStatusBar

protected void clearStatusBar()
Clears the status bar.


displayException

protected void displayException(java.lang.Throwable throwable)
Displays an exception. It takes a throwable object, determines what type of exception it is and calls the appropriate method. If not a valid throwable object for the application, a printStackTrace() is called.


displayException

public void displayException(BusinessException exception,
                             RetekLogger logger)
Displays a Business Exception.

Parameters:
exception - The Business Exception to display.

displayException

public void displayException(UiBusinessException exception,
                             RetekLogger logger)
Displays a UIBusinessException.

Parameters:
exception - The UiBusinessException to display.

displaySearchMessage

protected abstract void displaySearchMessage(java.lang.String message,
                                             ErrorSeverity severity)
Abstract methods for displaying exceptions.


displayMessage

protected abstract void displayMessage(java.lang.String message)

displayWarning

protected abstract void displayWarning(java.lang.String warning)

displayException

protected abstract void displayException(java.lang.RuntimeException exception)

displayException

protected abstract void displayException(SystemException exception)

displayException

protected abstract void displayException(ConcurrentUpdateException exception)


Copyright © 2005 Retek Inc. All Rights Reserved. - Generated at Fri, 01/21/2005 14:25