com.retek.commons.gui.widget
Class RTab

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.RTab
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, REventListener, java.io.Serializable
Direct Known Subclasses:
RcomDialogTab, RcomScreen, RcomTab, RmmScreen, RmmTab

public abstract class RTab
extends RPanel

This class subclasses RPanel to provide custom functionality for secondary tabs within a tabbed pane. Each RTab object represents a single tab of a tabbed pane.

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
RTab()
          Returns new RTab object.
 
Method Summary
 void clearAllExceptions()
          Clears the exceptions in the widget manager.
 void clearBusinessExceptions()
          Clears the business exceptions in the widget manager.
protected abstract  void clearStatusBar()
          Abstract methods that should be defined by sub-classes of RView.
 void clearUIExceptions()
          Clears the UI exceptions in the widget manager.
protected abstract  void displayException(BusinessException 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 in the appropriate manner.
protected abstract  void displayException(UiBusinessException exception)
           
protected abstract  void displayMessage(java.lang.String message)
           
protected abstract  void displaySearchMessage(java.lang.String message, ErrorSeverity severity)
          Abstract exceptions and message display methods to be defined by sub-classes.
protected abstract  void displayWarning(java.lang.String warning)
           
protected  RetekLogger getLogger()
          Retrieves the logger object to be used for this tab.
 WidgetManager getWidgetManager()
          Retrieves the widget manager for the tab.
 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 isShowable()
          Returns whether or not this tab's contents are showable.
 boolean isStartable()
          Determines if a tab may be started (gain focus).
 boolean isStoppable()
          Determines if the tab can be stopped (focus transferred to different tab).
 boolean isTabModified()
          Retrieves whether or not the widget values have been altered.
protected  void logDebug(java.lang.String message)
          Displays a debut message.
 void releaseWidget(java.lang.String widgetName)
          Releases a widget from error state based on a widget name.
 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 setShowable(boolean showable)
          Sets whether or not the contents of the tab should be displayed when the tab is active.
 void setStatusBar(RStatusBar statusBar)
          Assigns a status bar to the widget manager for the tab.
 void setTabModified(boolean modified)
          Sets the modified state of the contents of the tab.
 void start()
          Empty implementation of a start() method so that each RcomTab has one.
 void stop()
          Empty implementation of stop(), so that each RcomTab has one.
 
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

RTab

public RTab()
Returns new RTab object.

Method Detail

getWidgetManager

public WidgetManager getWidgetManager()
Retrieves the widget manager for the tab.

Returns:
The widget manager that belongs to this tab.

getLogger

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

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.

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.

setStatusBar

public void setStatusBar(RStatusBar statusBar)
Assigns a status bar to the widget manager for the tab.

Parameters:
statusBar - The status bar to assign to the widget manager.

setTabModified

public void setTabModified(boolean modified)
Sets the modified state of the contents of the tab.

Parameters:
modified - True if the tab contents are modified, false if not.

isTabModified

public boolean isTabModified()
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.

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.

releaseWidget

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

Parameters:
widgetName - The widget name to release from error state.

setShowable

public void setShowable(boolean showable)
Sets whether or not the contents of the tab should be displayed when the tab is active. If set to false, the tabbed pane using this tab will shrink its size when this tab is selected.

Parameters:
showable - True if the contents should be shown, false if not.

isShowable

public boolean isShowable()
Returns whether or not this tab's contents are showable.

Returns:
Whether or not this tab's contents are showable.

isStartable

public boolean isStartable()
Determines if a tab may be started (gain focus). Override this method if functionality is required to determine if a tab may be entered.


start

public void start()
Empty implementation of a start() method so that each RcomTab has one. Override this method if functionality is needed.


isStoppable

public boolean isStoppable()
Determines if the tab can be stopped (focus transferred to different tab). Override this method if funcionality is required to determine if a tab may be existed.


stop

public void stop()
Empty implementation of stop(), so that each RcomTab has one. Override this method if functionality is needed.


displayException

protected void displayException(java.lang.Throwable throwable)
Displays an exception in the appropriate manner. It determines if the exception is a UiBusinessException, SystemException or Runtime Exception and calls the appropriate abstract method. If the exception is none of these types, a stack trace is printed.

Parameters:
throwable - An throwable exception.

clearStatusBar

protected abstract void clearStatusBar()
Abstract methods that should be defined by sub-classes of RView.


displaySearchMessage

protected abstract void displaySearchMessage(java.lang.String message,
                                             ErrorSeverity severity)
Abstract exceptions and message display methods to be defined by sub-classes.


displayMessage

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

displayWarning

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

displayException

protected abstract void displayException(SystemException exception)

displayException

protected abstract void displayException(BusinessException exception)

displayException

protected abstract void displayException(UiBusinessException exception)

displayException

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


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