com.portal.search

Class SearchPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.portal.pfc.ui.ImagePanel

com.portal.bas.comp.PIAPanel

com.portal.search.SearchPanel

All Implemented Interfaces:

PClientComponent, PCollectDataListener, PComponent, PComponentAttribute, PViewComponent, PViewDataChangeListener, ContainerListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

public class SearchPanel
extends PIAPanel

Panel for doing searches. It contains two modes: one for displaying a single search template, one for displaying a group of templates in a tabbed pane for layered searching.

Version:

%version: 23 % %date_modified: Thu Feb 07 11:44:42 2002 %

Author:

mgaines

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class com.portal.bas.comp.PIAPanel

collectDataFromInvisiblePanels, isTracking, mIAList, mImpl

Fields inherited from class com.portal.pfc.ui.ImagePanel

IMAGE_CENTERED, IMAGE_SCALE_TO_HEIGHT, IMAGE_SCALE_TO_WIDTH, IMAGE_SCALED, IMAGE_TILED, mImageIcon, mScaledImage

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor and Description
SearchPanel()
SearchPanel(Properties p) Constructs a search panel using a tabbed pane for selecting search templates.
SearchPanel(Properties p, boolean b) Constructs a search panel using either a tabbed pane, which will allow the user to select from a list of templates, or a panel that displays a single template.
SearchPanel(Properties p, boolean b, String[] data, oracle.help.CSHManager cshManager) Constructs a search panel using either a tabbed pane, which will allow the user to select from a list of templates, or a panel that displays a single template.
SearchPanel(Properties p, boolean b, String tmpl, oracle.help.CSHManager cshManager) Constructs a search panel using either a tabbed pane, which will allow the user to select from a list of templates, or a panel that displays a single template.

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener l) Adds an action listener to the buttons of the dialog.
void	addSearchEventListener(SearchListener l) Add a search listener for the search results.
void	addSearchInfoListener(SearchInfoListener l) Add a SearchInfoListener.
void	addSearchResultsListener(ResultsListener l) Connects the search panel to a class that is interested in the results of the search.
void	collectData(PCollectDataEvent event) Override collectData(), turning it into a no-op.
protected void	fireSearchProgress(Integer prog) Sends a SearchEvent which contains the progress of the search.
protected void	fireSearchResultData(ResultData[] res) Sends a SearchEvent which contains the results of the search.
protected void	fireSearchResults(PModelHandle[] res) Sends a SearchEvent which contains the results of the search.
String	getControllerClassName() Gets the class name for this panel's controller.
void	removeActionListener(ActionListener l) Removes the given action listener from the dialog.
void	removeSearchEventListener(SearchListener l) Remove a search listener.
void	removeSearchInfoListener(SearchInfoListener l) Removes a SearchInfoListener.
void	removeSearchResultsListener(ResultsListener l) Disconnects the search panel to a class that is interested in the results of the search.
void	setCurrentTemplate(String tmpl) Updates the UI with the given template.
void	setInitialData(String[] data) Sets the initial data to be displayed in the panel.
void	setResultFields(String[] fields) Set the 'resultFields' property, which is used in the search.
void	setTabbedPane(boolean b) Sets the property tabbedPane to the given value.
void	setTemplates(Properties p) This method will initialize the SearchTemplates for the panel and it's controller.
void	viewDataChange(PViewDataChangeEvent event) Listens for change events from the controller.

Methods inherited from class com.portal.bas.comp.PIAPanel

clear, componentAdded, componentRemoved, containsError, firePropertyChange, fireVetoableChange, getBackgroundImageSource, getBundle, getModelHandle, getRemoteComponent, getResourceName, getTools, isClean, isCurrencyDisplay, isDirty, isError, isInputTracking, isLight, isRequired, processError, resetToDefault, revertToPrimary, setBackgroundImageMode, setBackgroundImageSource, setClean, setCurrencyDisplay, setDefault, setError, setInputTracking, setModelHandle, setRequired, setResourceName, togglePrimaryToSecondary, unregister

Methods inherited from class com.portal.pfc.ui.ImagePanel

getBackgroundImageIcon, getBackgroundImageMode, imageUpdate, paintComponent, setBackgroundImageIcon

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchPanel

public SearchPanel()

SearchPanel

public SearchPanel(Properties p)

Constructs a search panel using a tabbed pane for selecting search templates.

Parameters:

p - the search template definition

SearchPanel

public SearchPanel(Properties p,
                   boolean b)

Constructs a search panel using either a tabbed pane, which will allow the user to select from a list of templates, or a panel that displays a single template.

Parameters:

p - the search template definition

b - indicates whether the panel should use a tabbed pane

SearchPanel

public SearchPanel(Properties p,
                   boolean b,
                   String tmpl,
                   oracle.help.CSHManager cshManager)

Constructs a search panel using either a tabbed pane, which will allow the user to select from a list of templates, or a panel that displays a single template. The given template is then loaded in by default.

Parameters:

p - the search template definition

b - indicates whether the panel should use a tabbed pane

tmpl - the template to load in by default

cshManager - context Sensitive help manager

SearchPanel

public SearchPanel(Properties p,
                   boolean b,
                   String[] data,
                   oracle.help.CSHManager cshManager)

Constructs a search panel using either a tabbed pane, which will allow the user to select from a list of templates, or a panel that displays a single template. The given data is then loaded in by default.

Parameters:

p - the search template definition

b - indicates whether the panel should use a tabbed pane

data - the inital data to display in the window

cshManager - context Sensitive help manager

Method Detail

setCurrentTemplate

public void setCurrentTemplate(String tmpl)

Updates the UI with the given template. If the tabbed pane is showing, then the given panel is added to the pane, otherwise it replaces the exisiting panel.

Parameters:

tmpl - the template to load in the panel

setInitialData

public void setInitialData(String[] data)

Sets the initial data to be displayed in the panel.

Parameters:

data - any initial data to be loaded into the panel

setTabbedPane

public void setTabbedPane(boolean b)

Sets the property tabbedPane to the given value. If the value is false, than a single template will be shown. Note: this method will update the panel if possible.

Parameters:

b - if false, displays a single template

setTemplates

public void setTemplates(Properties p)

This method will initialize the SearchTemplates for the panel and it's controller. These templates are used to formulate searches and the controls displayed in the panel.

Parameters:

p - the new set of Properties to use.

addSearchEventListener

public void addSearchEventListener(SearchListener l)

Add a search listener for the search results.

Parameters:

l - the listener to add

removeSearchEventListener

public void removeSearchEventListener(SearchListener l)

Remove a search listener.

Parameters:

l - the listener to remove

addSearchInfoListener

public void addSearchInfoListener(SearchInfoListener l)

Add a SearchInfoListener. This listener will get information about the search excluding result information. As a side effect, if there are any remote listeners defined, they will be added to the remote listener list. The remote listeners will recieve information about the search results.

Parameters:

l - the listener to add.

removeSearchInfoListener

public void removeSearchInfoListener(SearchInfoListener l)

Removes a SearchInfoListener. As a side effect, if there are any remote listeners defined, they will be released from the remote listener list.

Parameters:

l - the listener to add.

addActionListener

public void addActionListener(ActionListener l)

Adds an action listener to the buttons of the dialog. The listener will be notified if one of the dialog buttons is pressed.

Parameters:

l - the action listener to be added

removeActionListener

public void removeActionListener(ActionListener l)

Removes the given action listener from the dialog.

Parameters:

l - the action listener to be removed

addSearchResultsListener

public void addSearchResultsListener(ResultsListener l)

Connects the search panel to a class that is interested in the results of the search.

Parameters:

l - the class interested in the search

removeSearchResultsListener

public void removeSearchResultsListener(ResultsListener l)

Disconnects the search panel to a class that is interested in the results of the search.

Parameters:

l - the class disinterested in the search

getControllerClassName

public String getControllerClassName()
                              throws RemoteException

Gets the class name for this panel's controller.

Specified by:

getControllerClassName in interface PComponent

Overrides:

getControllerClassName in class PIAPanel

Returns:

the controller's class name

Throws:

RemoteException - thrown for errors

collectData

public void collectData(PCollectDataEvent event)

Override collectData(), turning it into a no-op. This panel uses it's own mechanism for collecting search criteria.

Specified by:

collectData in interface PCollectDataListener

Overrides:

collectData in class PIAPanel

Parameters:

event - the PCollectDataEvent data event

viewDataChange

public void viewDataChange(PViewDataChangeEvent event)
                    throws RemoteException

Listens for change events from the controller.

Specified by:

viewDataChange in interface PViewDataChangeListener

Overrides:

viewDataChange in class PIAPanel

Parameters:

event - the data change event

Throws:

RemoteException - thrown for errors

setResultFields

public void setResultFields(String[] fields)

Set the 'resultFields' property, which is used in the search. This will ensure that these fields are returned from the search results regardless of the fields that are defined in the search template.

Parameters:

fields - the new list of fields expected for each found result

fireSearchProgress

protected void fireSearchProgress(Integer prog)

Sends a SearchEvent which contains the progress of the search.

Parameters:

prog - the number of items found in the search

fireSearchResults

protected void fireSearchResults(PModelHandle[] res)

Sends a SearchEvent which contains the results of the search.

Parameters:

event - the search event

fireSearchResultData

protected void fireSearchResultData(ResultData[] res)

Sends a SearchEvent which contains the results of the search.

Parameters:

event - the search event