com.retek.commons.gui.widget
Class RSearchDialog

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Dialog
                  extended byjavax.swing.JDialog
                      extended bycom.retek.commons.gui.widget.RDialog
                          extended bycom.retek.commons.gui.widget.RSearchDialog
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, 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:
CustomerSearchDialog, NegativeFraudSearchDialog

public abstract class RSearchDialog
extends RDialog
implements java.awt.event.ActionListener

This class is a superclass of all basic search windows. It provides several protected variables that are controlled by the sub-classes (the criteria panel, the results table, and the status bar).

Retek Inc. Copyright (c) 2002

See Also:
Serialized Form

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
RSearchDialog(javax.swing.JFrame frame)
          Creates a new search dialog superclass.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent event)
          Decides which of the three basic events occurred and calls the appropriate method.
protected  void addButton(RButton button)
          Adds a button to the button panel.
protected abstract  void buildCriteriaPanel()
          Defined by all sub-classes to build widgets forthe criteria panel.
protected abstract  void buildResultTable()
          Defined by all sub-classes to build columns for the result table.
protected  void clearResultTable()
          Clears the result table of all information.
 void closeWindow()
          Close the window.
protected abstract  void doCancelSearch()
          Implemented by sub-classes to perform the cancel search action.
protected abstract  void doOK()
          Implemented by sub-classes to handle the "OK" action.
protected abstract  void doSearch()
          Implemented by sub-classes to perform the actual specific search.
protected  void doSearchCommand()
          Perform the search command logic - setting the window into search mode and triggering the search.
 void enableCancelButton(boolean enabled)
          Enabled/Disable the Cancel Button
 void enableOkayButton(boolean enabled)
          Enabled/Disable the Ok Button
 void enableSearchButton(boolean enabled)
          Enabled/Disable the Search Button
protected  void fillResultTable(java.util.List tableList)
          Fills the result table with the information in the table list.
protected  RPanel getCriteriaPanel()
          Returns the criteria panel for the search dialog window.
protected  RDisplayTable getResultTable()
          Returns the results table of the search dialog window.
protected  java.lang.Object getSelectedSecondaryData(java.lang.String columnName)
          Retrieves the secondary data for a particular column in the currently selected row.
 void initialize()
          Calls abstract methods in child class upon initialization.
 void performActionEvent(RActionEvent event)
          Triggered when a table row is double-clicked.
protected  void setNormalMode()
          Sets the search window to normal mode.
protected  void setResultsPanelVisible(boolean visible)
           
 void show()
          Override the show method to make sure that the search happens immediately.
 
Methods inherited from class com.retek.commons.gui.widget.RDialog
addREventListener, centerWindow, clearAllExceptions, clearBusinessExceptions, clearStatusBar, clearUIExceptions, clearWidgetHistory, displayException, displayException, displayException, displayException, displayException, displayException, displayException, displayMessage, displaySearchMessage, displaySearchMessage, displayWarning, getLogger, getStatusBar, getWidgetManager, hasAnyExceptions, hasBusinessExceptions, hasUIExceptions, indentWindow, isDialogModified, logDebug, notifyREventListeners, notifyREventListeners, performErrorEvent, recover, releaseWidget, removeAllREventListeners, removeREventListener, setActionsEnabled, setDialogModified, setMonitorEnabled, setTitle, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened
 
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
 
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

RSearchDialog

public RSearchDialog(javax.swing.JFrame frame)
Creates a new search dialog superclass.

Parameters:
frame - The parent frame that will own the dialog.
Method Detail

addButton

protected void addButton(RButton button)
Adds a button to the button panel.

Parameters:
button - The button to add to the panel.

getCriteriaPanel

protected RPanel getCriteriaPanel()
Returns the criteria panel for the search dialog window.

Returns:
The criteria panel for the search dialog window.

getResultTable

protected RDisplayTable getResultTable()
Returns the results table of the search dialog window.

Returns:
The result table of the search dialog window.

initialize

public void initialize()
Calls abstract methods in child class upon initialization.

Throws:
SystemException - Thrown if a system failure occurs during initialization.

buildCriteriaPanel

protected abstract void buildCriteriaPanel()
Defined by all sub-classes to build widgets forthe criteria panel.


buildResultTable

protected abstract void buildResultTable()
Defined by all sub-classes to build columns for the result table.


actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)
Decides which of the three basic events occurred and calls the appropriate method.

Specified by:
actionPerformed in interface java.awt.event.ActionListener

performActionEvent

public void performActionEvent(RActionEvent event)
Triggered when a table row is double-clicked.

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

doSearchCommand

protected void doSearchCommand()
Perform the search command logic - setting the window into search mode and triggering the search.


setNormalMode

protected void setNormalMode()
Sets the search window to normal mode.


doSearch

protected abstract void doSearch()
                          throws SystemException
Implemented by sub-classes to perform the actual specific search.

Throws:
SystemException

doCancelSearch

protected abstract void doCancelSearch()
Implemented by sub-classes to perform the cancel search action.


doOK

protected abstract void doOK()
Implemented by sub-classes to handle the "OK" action.


clearResultTable

protected void clearResultTable()
Clears the result table of all information.


enableOkayButton

public void enableOkayButton(boolean enabled)
Enabled/Disable the Ok Button


enableCancelButton

public void enableCancelButton(boolean enabled)
Enabled/Disable the Cancel Button


enableSearchButton

public void enableSearchButton(boolean enabled)
Enabled/Disable the Search Button


setResultsPanelVisible

protected void setResultsPanelVisible(boolean visible)

fillResultTable

protected void fillResultTable(java.util.List tableList)
Fills the result table with the information in the table list.


getSelectedSecondaryData

protected java.lang.Object getSelectedSecondaryData(java.lang.String columnName)
Retrieves the secondary data for a particular column in the currently selected row.

Parameters:
columnName - The name of the column to retrieve the data object for.
Returns:
The secondary data object stored at the selected row for the column name.

show

public void show()
Override the show method to make sure that the search happens immediately.


closeWindow

public void closeWindow()
Close the window.



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