org.kepler.gui

Class SearchUIJPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.kepler.gui.SearchUIJPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class SearchUIJPanel
extends javax.swing.JPanel

Class to build the Search User Interface JPanel that allows the user to enter a single search term to search by. 5 buttons can be optionally configured by setting Actions for those buttons.

The 5 configurable buttons are
• Search Button
• Reset Button
• Cancel Button
• Source Button
• Advanced Button

Since:

4 Nov 2005

Author:

brooke

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADV_BUTTON_CAPTION
static java.lang.String	CANCEL_BUTTON_CAPTION
static java.lang.String	SEARCH_BUTTON_CAPTION
static boolean	SEARCHREPOS
static java.lang.String	SOURCE_BUTTON_CAPTION

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
SearchUIJPanel() Empty constructor.
SearchUIJPanel(java.lang.String panelBorderTitle, javax.swing.Action searchButtonAction, javax.swing.Action resetButtonAction, javax.swing.Action cancelButtonAction, javax.swing.Action sourceButtonAction, javax.swing.Action advancedButtonAction) Constructor - creates a panel with a titled border (from String param panelBorderTitle), containing a textfield with up to 5 buttons beneath it.

Method Summary

Modifier and Type	Method and Description
void	closing()
javax.swing.Action	getAdvancedAction() Returns the javax.swing.Action object that is called when the Advanced button is pressed.
java.lang.String	getBorderTitle() Returns the border title for this search panel.
javax.swing.Action	getCancelAction() Returns the javax.swing.Action object that is called when the Cancel button is pressed.
int	getMinimumWidth() get the preferred/minimum width of this panel - calculated to allow enough space for all buttons and spacers etc
javax.swing.Action	getSearchAction() Returns the javax.swing.Action object that is called when the Search button is pressed.
java.lang.String	getSearchTerm()
javax.swing.Action	getSourceAction() Returns the javax.swing.Action object that is called when the Source button is pressed.
void	init() Initialize the search panel.
void	setAdvancedAction(javax.swing.Action advancedAction) Sets the Action to be used when the Advanced button is pressed.
void	setAllSearchEnabled(boolean enabled) Enables/disables _all_ Search buttons we will use this to disable all buttons as we fetch datasources from the repository if enabled==true, enable the textfield, search, reset, source and advanced buttons, and cancel button.
void	setBorderTitle(java.lang.String borderTitle)
void	setCancelAction(javax.swing.Action cancelAction) Sets the Action to be used when the Cancel button is pressed.
void	setCancelButtonEnabled(boolean enabled)
void	setSearchAction(javax.swing.Action searchAction) Sets the Action to be used when the Search button is pressed.
void	setSearchEnabled(boolean enabled) if enabled==true, enable the textfield, search, reset, source and advanced buttons, and disable the cancel button.
void	setSearchTerm(java.lang.String searchTerm) set the current search term String in the textfield
void	setSourceAction(javax.swing.Action sourceAction) Sets the Action to be used when the Source button is pressed.

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, fireVetoableChange, 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, paintComponent, 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, 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, imageUpdate, 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

Field Detail

SEARCHREPOS

public static boolean SEARCHREPOS

SEARCH_BUTTON_CAPTION

public static final java.lang.String SEARCH_BUTTON_CAPTION

CANCEL_BUTTON_CAPTION

public static final java.lang.String CANCEL_BUTTON_CAPTION

SOURCE_BUTTON_CAPTION

public static final java.lang.String SOURCE_BUTTON_CAPTION

ADV_BUTTON_CAPTION

public static final java.lang.String ADV_BUTTON_CAPTION

Constructor Detail

SearchUIJPanel

public SearchUIJPanel()

Empty constructor.

SearchUIJPanel

public SearchUIJPanel(java.lang.String panelBorderTitle,
                      javax.swing.Action searchButtonAction,
                      javax.swing.Action resetButtonAction,
                      javax.swing.Action cancelButtonAction,
                      javax.swing.Action sourceButtonAction,
                      javax.swing.Action advancedButtonAction)

Constructor - creates a panel with a titled border (from String param panelBorderTitle), containing a textfield with up to 5 buttons beneath it. Constructor can accept javax.swing.Action objects for these 5 buttons; if any of these Action objects is null, the button will not be displayed on the user interface at runtime

Parameters:

panelBorderTitle - String

searchButtonAction - Action

resetButtonAction - Action

cancelButtonAction - Action

sourceButtonAction - Action

advancedButtonAction - Action

Method Detail

getBorderTitle

public java.lang.String getBorderTitle()

Returns the border title for this search panel. The default title is "Search".

Returns:

the search border title

setBorderTitle

public void setBorderTitle(java.lang.String borderTitle)

getSearchAction

public javax.swing.Action getSearchAction()

Returns the javax.swing.Action object that is called when the Search button is pressed.

Returns:

the Action object that handles the search button

setSearchAction

public void setSearchAction(javax.swing.Action searchAction)

Sets the Action to be used when the Search button is pressed. If this Action is not set then the Search button will not be visible to the user.

Parameters:

searchAction - the Action to be used when the Search button is pressed

getCancelAction

public javax.swing.Action getCancelAction()

Returns the javax.swing.Action object that is called when the Cancel button is pressed.

Returns:

the Action object that handles the Cancel button

setCancelAction

public void setCancelAction(javax.swing.Action cancelAction)

Sets the Action to be used when the Cancel button is pressed. If this Action is not set then the Cancel button will not be visible to the user.

Parameters:

cancelAction - the Action to be used when the Cancel button is pressed

getSourceAction

public javax.swing.Action getSourceAction()

Returns the javax.swing.Action object that is called when the Source button is pressed.

Returns:

the Action object that handles the Source button

setSourceAction

public void setSourceAction(javax.swing.Action sourceAction)

Sets the Action to be used when the Source button is pressed. If this Action is not set then the Source button will not be visible to the user.

Parameters:

sourceAction - the Action to be used when the Source button is pressed

getAdvancedAction

public javax.swing.Action getAdvancedAction()

Returns the javax.swing.Action object that is called when the Advanced button is pressed.

Returns:

the Action object that handles the Advanced button

setAdvancedAction

public void setAdvancedAction(javax.swing.Action advancedAction)

Sets the Action to be used when the Advanced button is pressed. If this Action is not set then the Advanced button will not be visible to the user.

Parameters:

advancedAction - the Action to be used when the Advanced button is pressed

getSearchTerm

public java.lang.String getSearchTerm()

Returns:

the current search term String from the textfield

getMinimumWidth

public final int getMinimumWidth()

get the preferred/minimum width of this panel - calculated to allow enough space for all buttons and spacers etc

Returns:

the minimum allowable width of this panel

setSearchTerm

public void setSearchTerm(java.lang.String searchTerm)

set the current search term String in the textfield

Parameters:

searchTerm - String

setSearchEnabled

public void setSearchEnabled(boolean enabled)

if enabled==true, enable the textfield, search, reset, source and advanced buttons, and disable the cancel button. If enabled==false, do the reverse.

Parameters:

enabled - boolean

setCancelButtonEnabled

public void setCancelButtonEnabled(boolean enabled)

setAllSearchEnabled

public void setAllSearchEnabled(boolean enabled)

Enables/disables _all_ Search buttons we will use this to disable all buttons as we fetch datasources from the repository if enabled==true, enable the textfield, search, reset, source and advanced buttons, and cancel button. If enabled==false, do the reverse.

Parameters:

enabled - boolean

init

public void init()

Initialize the search panel. This should be called after constructing and adding whichever Actions you want the search panel to contain.

closing

public void closing()