|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--javax.swing.JComponent | +--com.ibm.mm.beans.gui.CMBSearchTemplateViewer
The CMBSearchTemplateViewer displays the fields to specify the search criteria as defined in the search template (defined by the system administrator). Each search criterion has a label, a list of operators, and a text field. For range operators, two text fields are displayed. The CMBSearchTemplateViewer also launches off a search, and fires the CMBSearchResultsEvent to return the results of the search.
Text Search
In addition to searching on indexing attributes, the search template can also contain one or more text search criteria, via a simple text field on the search template. No operators are supported within the text entered in the text field; the text is interpreted as a single phrase. The search template creator will define how this phrase is used to search the documents. (Examples: exact match, case insensitive, linguistic)
Start Search button
If the searchButtonVisible property is set to true, then this button will be shown. Pressing this button will launch a search.
Enter action
If the launchSearchOnEnter property is set to true, then pressing enter on the template viewer will launch a search.
Inner classes inherited from class javax.swing.JComponent |
javax.swing.JComponent.AccessibleJComponent |
Inner classes inherited from class java.awt.Container |
java.awt.Container.AccessibleAWTContainer |
Inner classes inherited from class java.awt.Component |
java.awt.Component.AccessibleAWTComponent |
Field Summary | |
static int |
CONTROL_1
Constant to indicate the first control of an STCriterion |
static int |
CONTROL_2
Constant to indicate the second control of an STCriterion. |
static int |
LAST_TIME
Each field is filled in with values it contained the last time it was shown. |
static int |
NO_FOCUS
Indicates that no criterion field currently has focus. |
static int |
PREVIOUS_VIEW
Fields are filled with like-named values from the previously viewed template. |
static int |
SYSTEM
Fields are filled in with system administrator defaults. |
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 com.ibm.mm.beans.gui.CMBTemplateSelectedListener |
copyright |
Fields inherited from interface java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
CMBSearchTemplateViewer()
Constructor for the CMBSearchTemplateViewer. |
Method Summary | |
void |
addChangePasswordHelpListener(CMBChangePasswordHelpListener listener)
Add the specified listener, which will receive CMBChangePasswordHelpEvents from the CMBSearchTemplateViewer |
void |
addHelpListener(CMBHelpListener listener)
Add the specified listener, which will receive CMBHelpEvents from the CMBSearchTemplateViewer |
void |
addLoginFailedHelpListener(CMBLoginFailedHelpListener listener)
Add the specified listener, which will receive CMBLoginFailedHelpEvents from the CMBSearchTemplateViewer |
void |
addNotify()
|
void |
addSearchCompletedListener(CMBSearchCompletedListener listener)
Add the specified listener, which will receive CMBSearchCompletedEvents from the CMBSearchTemplateViewer |
void |
addSearchResultsListener(CMBSearchResultsListener listener)
Add the specified listener, which will receive CMBSearchResultsEvents from the CMBSearchTemplateViewer |
void |
addSearchStartedListener(CMBSearchStartedListener listener)
Add the specified listener, which will receive CMBSearchStartedEvents from the CMBSearchTemplateViewer |
void |
addServerUnavailableHelpListener(CMBServerUnavailableHelpListener listener)
Add the specified listener, which will receive CMBServerUnavailableHelpEvents from the CMBSearchTemplateViewer |
void |
addTemplateFieldChangedListener(CMBTemplateFieldChangedListener listener)
Add the specified listener, which will receive CMBTemplateFieldChangedEvents from the CMBSearchTemplateViewer |
void |
addTemplateFieldEnterPressedListener(CMBTemplateFieldEnterPressedListener listener)
Add the specified listener, which will receive CMBTemplateFieldEnterPressedEvents from the CMBSearchTemplateViewer |
void |
addTemplateFieldPopupListener(CMBTemplateFieldPopupListener listener)
Add the specified listener, which will receive CMBTemplateFieldPopupEvents from the CMBSearchTemplateViewer |
void |
cancelSearch()
Cancel a search in progress |
void |
clear()
Clear the fields of the template |
void |
clearAllTemplates()
Get rid of all templates from card layout and hashtables |
void |
clearQuery()
|
void |
deepReset()
Reset the templates using the current values in the non-visual beans Get rid of all stored information |
CMBConnection |
getConnection()
Get the connection object for the CMBSearchTemplateViewer |
CMBSTCriterion |
getCriterionWithFocus()
Get the criterion whose field which currently has focus |
int |
getDefaultsOption()
Get the option for how fields are initially filled in when a template is selected for a view. |
int |
getFieldWithFocus()
Get the field which currently has focus |
int |
getMaxResults()
Get the maximum number of results to return from a search. |
char |
getParmFieldWildcard()
Get the character which represents a wildcard for 0 or more characters for parametric search criteria. |
CMBSearchTemplate |
getTemplate()
Get the search template object currently being displayed |
char |
getTextMultiCharsWildcard()
Get the character which represents a wildcard for 0 or more characters for text query criteria. |
char |
getTextSingleCharWildcard()
Get the character which represents a wildcard for 1 character for text query criteria. |
boolean |
isLaunchSearchOnEnter()
Determine if a search should be launched if enter is pressed in a template field The default value is true. |
boolean |
isPromptOnServerUnavailable()
Determine if the start search button should be shown |
boolean |
isSearchInProgress()
Determine whether a search is currently in progress |
boolean |
isStartSearchButtonVisible()
|
boolean |
isStopSearchButtonVisible()
Determine if the stop search button should be shown |
void |
onCMBSearchReply(CMBSearchReplyEvent event)
Implementation of the CMBSearchReplyListener, for easy wiring to CMBSearchTemplateList bean. |
void |
onTemplateSelected(CMBTemplateSelectedEvent event)
Implementation of the CMBTemplateSelectedListener, for easy wiring to CMBSearchTemplateList bean. |
void |
refresh()
Refresh the template from the federated database |
void |
removeChangePasswordHelpListener(CMBChangePasswordHelpListener listener)
Remove the specified listener so it will no longer receive CMBChangePasswordHelpEvents from the CMBSearchTemplateViewer |
void |
removeHelpListener(CMBHelpListener listener)
Remove the specified listener so it will no longer receive CMBHelpEvents from the CMBSearchTemplateViewer |
void |
removeLoginFailedHelpListener(CMBLoginFailedHelpListener listener)
Remove the specified listener so it will no longer receive CMBLoginFailedHelpEvents from the CMBSearchTemplateViewer |
void |
removeSearchCompletedListener(CMBSearchCompletedListener listener)
Remove the specified listener so it will no longer receive CMBSearchCompletedEvents from the CMBSearchTemplateViewer |
void |
removeSearchResultsListener(CMBSearchResultsListener listener)
Remove the specified listener so it will no longer receive CMBSearchResultsEvents from the CMBSearchTemplateViewer |
void |
removeSearchStartedListener(CMBSearchStartedListener listener)
Remove the specified listener so it will no longer receive CMBSearchStartedEvents from the CMBSearchTemplateViewer |
void |
removeServerUnavailableHelpListener(CMBServerUnavailableHelpListener listener)
Remove the specified listener so it will no longer receive CMBServerUnavailableHelpEvents from the CMBSearchTemplateViewer |
void |
removeTemplateFieldChangedListener(CMBTemplateFieldChangedListener listener)
Remove the specified listener so it will no longer receive CMBTemplateFieldChangedEvents from the CMBSearchTemplateViewer |
void |
removeTemplateFieldEnterPressedListener(CMBTemplateFieldEnterPressedListener listener)
Remove the specified listener so it will no longer receive CMBTemplateFieldEnterPressedEvents from the CMBSearchTemplateViewer |
void |
removeTemplateFieldPopupListener(CMBTemplateFieldPopupListener listener)
Remove the specified listener so it will no longer receive CMBTemplateFieldPopupEvents from the CMBSearchTemplateViewer |
void |
reset()
Reset the values of all fields back to the default values |
void |
restoreConfiguration(java.util.Properties restoreProperties)
Restore the attributes of the search template. |
void |
saveConfiguration(java.util.Properties saveProperties)
Save the attributes of all search templates. |
void |
setBackground(java.awt.Color newColor)
Overrides the setBackground function |
void |
setConnection(CMBConnection newConnection)
Set the connection object for the CMBSearchTemplateViewer |
void |
setCriterionWithFocus(CMBSTCriterion newCriterionWithFocus)
Set the criterion whose field currently has focus |
void |
setCursor(java.awt.Cursor newCursor)
Overridden to set cursor of contained controls |
void |
setDefaultsOption(int newOption)
Set the option for how fields are initially filled in when a template is selected for a view. |
void |
setEnabled(boolean newEnable)
Overridden to enable/disable contained controls |
void |
setFieldWithFocus(int newField)
Set the field which currently has focus |
void |
setFont(java.awt.Font newFont)
Overrides the setFont function |
void |
setForeground(java.awt.Color newColor)
Overrides the setForeground function |
void |
setLaunchSearchOnEnter(boolean newVal)
Set whether a search should be launched if enter is pressed in a template field |
void |
setLayout(java.awt.LayoutManager mgr)
Overridden to disable changing of the layout manager. |
void |
setLocale(java.util.Locale newLocale)
Overrides the setLocale function |
void |
setMaxResults(int newResults)
Set the maximum number of results to return from a search This maximum is set per backend, so the total results can be greater if the search involves multiple content servers. |
void |
setOpaque(boolean newOpaque)
Overridden to set opaque on contained controls |
void |
setParmFieldWildcard(char newChar)
Set the character which represents a wildcard for 0 or more characters for parametric search criteria. |
void |
setPromptOnServerUnavailable(boolean newVal)
|
void |
setStartSearchButtonVisible(boolean newVal)
Set whether the start search button should be shown |
void |
setStopSearchButtonVisible(boolean newVal)
Set whether the stop search button should be shown |
void |
setTemplate(CMBSearchTemplate newTemplate)
Set the search template object to be displayed |
void |
setTextMultiCharsWildcard(char newChar)
Set the character which represents a wildcard for 0 or more characters for text query criteria. |
void |
setTextSingleCharWildcard(char newChar)
Set the character which represents a wildcard for 1 character for text query criteria. |
void |
setToolTipText(java.lang.String newTooltip)
Overridden to set tooltip text on contained controls |
void |
startSearch()
Launch the search, using the search criteria specified in the template |
void |
updateUI()
|
Methods inherited from class javax.swing.JComponent |
addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getUIClassID, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update |
Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, validate, validateTree |
Methods inherited from class java.awt.Component |
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int SYSTEM
public static final int LAST_TIME
public static final int PREVIOUS_VIEW
public static final int NO_FOCUS
public static final int CONTROL_1
public static final int CONTROL_2
Constructor Detail |
public CMBSearchTemplateViewer()
Method Detail |
public void addNotify()
addNotify
in class javax.swing.JComponent
public CMBConnection getConnection()
public void setConnection(CMBConnection newConnection)
public CMBSearchTemplate getTemplate()
public void setTemplate(CMBSearchTemplate newTemplate)
public int getDefaultsOption()
public void setDefaultsOption(int newOption)
public CMBSTCriterion getCriterionWithFocus()
public void setCriterionWithFocus(CMBSTCriterion newCriterionWithFocus)
public int getFieldWithFocus()
public void setFieldWithFocus(int newField)
public boolean isLaunchSearchOnEnter()
public void setLaunchSearchOnEnter(boolean newVal)
public boolean isPromptOnServerUnavailable()
public void setPromptOnServerUnavailable(boolean newVal)
public boolean isStartSearchButtonVisible()
public void setStartSearchButtonVisible(boolean newVal)
public boolean isStopSearchButtonVisible()
public void setStopSearchButtonVisible(boolean newVal)
public char getTextMultiCharsWildcard()
public void setTextMultiCharsWildcard(char newChar)
public char getTextSingleCharWildcard()
public void setTextSingleCharWildcard(char newChar)
public char getParmFieldWildcard()
public void setParmFieldWildcard(char newChar)
public int getMaxResults()
public void setMaxResults(int newResults)
public boolean isSearchInProgress()
public void refresh()
public void deepReset()
public void clearAllTemplates()
public void clear()
public void reset()
public void startSearch()
public void cancelSearch()
public void clearQuery()
public void saveConfiguration(java.util.Properties saveProperties)
saveProperties
- The properties file to save the configuration to.public void restoreConfiguration(java.util.Properties restoreProperties)
restoreProperties
- The properties file to restore the configuration from.public void setLocale(java.util.Locale newLocale)
setLocale
in class java.awt.Component
public void updateUI()
updateUI
in class javax.swing.JComponent
public void setForeground(java.awt.Color newColor)
setForeground
in class javax.swing.JComponent
public void setBackground(java.awt.Color newColor)
setBackground
in class javax.swing.JComponent
public void setFont(java.awt.Font newFont)
setFont
in class javax.swing.JComponent
public void setCursor(java.awt.Cursor newCursor)
setCursor
in class java.awt.Component
public void setOpaque(boolean newOpaque)
setOpaque
in class javax.swing.JComponent
public void setToolTipText(java.lang.String newTooltip)
setToolTipText
in class javax.swing.JComponent
public void setEnabled(boolean newEnable)
setEnabled
in class javax.swing.JComponent
public void setLayout(java.awt.LayoutManager mgr)
setLayout
in class java.awt.Container
public void onCMBSearchReply(CMBSearchReplyEvent event)
onCMBSearchReply
in interface CMBSearchReplyListener
event
- The search reply event received from the nonvisual CMBSearchTemplate bean.public void onTemplateSelected(CMBTemplateSelectedEvent event)
onTemplateSelected
in interface CMBTemplateSelectedListener
event
- The template selected event received from the CMBSearchTemplateList
visual bean.public void addTemplateFieldChangedListener(CMBTemplateFieldChangedListener listener)
listener
- The new listenerpublic void removeTemplateFieldChangedListener(CMBTemplateFieldChangedListener listener)
listener
- The listener to be removedpublic void addTemplateFieldPopupListener(CMBTemplateFieldPopupListener listener)
listener
- The new listenerpublic void removeTemplateFieldPopupListener(CMBTemplateFieldPopupListener listener)
listener
- The listener to be removedpublic void addTemplateFieldEnterPressedListener(CMBTemplateFieldEnterPressedListener listener)
public void removeTemplateFieldEnterPressedListener(CMBTemplateFieldEnterPressedListener listener)
public void addSearchStartedListener(CMBSearchStartedListener listener)
public void removeSearchStartedListener(CMBSearchStartedListener listener)
public void addSearchResultsListener(CMBSearchResultsListener listener)
public void removeSearchResultsListener(CMBSearchResultsListener listener)
public void addSearchCompletedListener(CMBSearchCompletedListener listener)
public void removeSearchCompletedListener(CMBSearchCompletedListener listener)
public void addChangePasswordHelpListener(CMBChangePasswordHelpListener listener)
listener
- The new listenerpublic void removeChangePasswordHelpListener(CMBChangePasswordHelpListener listener)
listener
- The listener to be removedpublic void addServerUnavailableHelpListener(CMBServerUnavailableHelpListener listener)
listener
- The new listenerpublic void removeServerUnavailableHelpListener(CMBServerUnavailableHelpListener listener)
listener
- The listener to be removedpublic void addLoginFailedHelpListener(CMBLoginFailedHelpListener listener)
listener
- The new listenerpublic void removeLoginFailedHelpListener(CMBLoginFailedHelpListener listener)
listener
- The listener to be removedpublic void addHelpListener(CMBHelpListener listener)
public void removeHelpListener(CMBHelpListener listener)
|
EIP JavaBeans | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |