Package com.portal.browse
Interface ResultsDisplay
- All Superinterfaces:
EventListener,SearchInfoListener
- All Known Implementing Classes:
EventResultsTablePanel,ResultsTablePanel
An interface for BrowseWin which defines the methods needed for displaying
search results.
- Version:
- %version: 9 % %date_modified: Fri Feb 09 15:59:15 2001 %
- Author:
- Monica Gaines
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intConstant used to specifiy the object is an event type.static final intConstant used to specifiy a generic object. -
Method Summary
Modifier and TypeMethodDescriptionvoidClears the display of it's contents.voidCloses lingering open portal contextvoiddisplayDetails(int type) Displays the detail information of the selected object.Returns the list of marked eventsReturns an array of history items that contain poid and account information about the selected items in the display.voidUsed to initialize the controller with the neccessary strings for retrieving search results.intReturns the number of items displayed.voidMark all the items in the display.voidmarkItem()Mark the currently selected item.voidselectFirstItem(int i) Select/highlight the first item in the list of results.voidsetMaskFields(String[] flds) Sets the fields that need to be masked, i.e.voidsetResultData(ResultData[] data, int sortIndex, boolean b) Sets the information used for displaying the results.voidDisplays all the items, marked and unmarked.booleanDisplay the list of marked itemsvoidsubstituteData(Hashtable data) Substitute the given data when viewing object details.voidUnmark all the items.voidUnmark the currently selected item.Methods inherited from interface com.portal.search.SearchInfoListener
getRemoteListener, progress, releaseRemoteListener, searchStarted
-
Field Details
-
EVENT_TYPE
static final int EVENT_TYPEConstant used to specifiy the object is an event type.- See Also:
-
OBJECT_TYPE
static final int OBJECT_TYPEConstant used to specifiy a generic object.- See Also:
-
-
Method Details
-
clearContents
void clearContents()Clears the display of it's contents. -
markItem
void markItem()Mark the currently selected item. -
unmarkItem
void unmarkItem()Unmark the currently selected item. -
markAllItems
void markAllItems()Mark all the items in the display. -
unmarkAllItems
void unmarkAllItems()Unmark all the items. -
initSearchResults
void initSearchResults()Used to initialize the controller with the neccessary strings for retrieving search results. -
selectFirstItem
void selectFirstItem(int i) Select/highlight the first item in the list of results.- Parameters:
i- the type of action that should be performed on the results
-
showMarkedItems
boolean showMarkedItems()Display the list of marked items- Returns:
- returns false if there are no marked items to display
-
showAllItems
void showAllItems()Displays all the items, marked and unmarked. -
setMaskFields
Sets the fields that need to be masked, i.e. there values hidden when looking at object details.- Parameters:
flds- the fields to be masked
-
substituteData
Substitute the given data when viewing object details.- Parameters:
data- the data to substitute
-
itemCount
int itemCount()Returns the number of items displayed.- Returns:
- the number of items displayed
-
getSelectedItems
HistoryItem[] getSelectedItems()Returns an array of history items that contain poid and account information about the selected items in the display.- Returns:
- an array of history items
-
getMarkedEvents
Hashtable getMarkedEvents()Returns the list of marked events- Returns:
- the marked events
-
setResultData
Sets the information used for displaying the results.- Parameters:
data- the data defining the results to displayindex- the index used for sorting
-
displayDetails
void displayDetails(int type) Displays the detail information of the selected object.- Parameters:
type- type of object to display, either EVENT_TYPE or OBJECT_TYPE
-
closeContext
void closeContext()Closes lingering open portal context
-