com.usefullittlethings.saw.ui
Interface SearchUIIfc

All Known Implementing Classes:

CommandLineSearchUI, DefaultSearchUI

public interface SearchUIIfc

Interface describing an implementation of the main user interface for the Search and Whatever core application.

Method Summary

void	addActionUI(int index, java.awt.Component c, java.lang.String title) Adds the action's ui to the user interface.
void	addFilterUI(int index, java.awt.Component c, java.lang.String title) Adds the filter's ui to the user interface.
void	disableForSearch() Tells the user interface to stop accepting user input for the duration of a search operation.
void	dispose() Disposes of this ui component, only to be used when application is exiting.
void	enableAfterSearch() Tells the user interface to start accepting user input at the completion of a search operation.
java.io.File	getOpenFromLocation() Displays an open dialog and returns the selection.
java.io.File	getSaveToLocation() Displays a save dialog and returns the selection.
StartupUIIfc	getStartupUI()
void	removeActionUI(java.awt.Component c) Removes the ui of the filter specified by the index from the user interface.
void	removeFilterUI(java.awt.Component c) Removes the ui of the filter specified by the index from the user interface.
void	setActionsModel(PluginCollection c) Used to set a reference to the actions model within the ui.
void	setActionSummary(java.lang.String summary) Sets a summary of the actions' configuration in the ui.
void	setAppTitle(java.lang.String title) Sets the application title to the specified value.
void	setController(AppControllerIfc controller) Registers the application-level controller with the user interface to receive application-level events, such as exit requests, etc.
void	setFiltersModel(PluginCollection c) Used to set a reference to the filters model within the ui.
void	setFilterSummary(java.lang.String summary) Sets a summary of the filters' configuration in the ui.
void	setSearchRootUI(SearchRootUIIfc root) Installs the "panel" responsible for handling selection of the root location for the search to be performed.
void	show() Displays the ui.
boolean	showConfirmInterrupt() Shows the user a confirmation prompt to determine if the currently executing search should be stopped.
void	showLoadError() Display an error for the user indicating that the load process failed.
void	showNoCommonSupportError() Displays the an error indicating that there is no single search pattern supported by both the search plug-in and the selected filter/action plug-ins.
void	showStatusMessage(java.lang.String message) Displays feedback to the user, such as in the status bar of a window.
void	updateUI() Updates the user interface to reflect any changes that may have occurred in the model.

Method Detail

getStartupUI

public StartupUIIfc getStartupUI()

show

public void show()

Displays the ui.

dispose

public void dispose()

Disposes of this ui component, only to be used when application is exiting.

updateUI

public void updateUI()

Updates the user interface to reflect any changes that may have occurred in the model.

setAppTitle

public void setAppTitle(java.lang.String title)

Sets the application title to the specified value.

setController

public void setController(AppControllerIfc controller)

Registers the application-level controller with the user interface to receive application-level events, such as exit requests, etc.

showNoCommonSupportError

public void showNoCommonSupportError()

Displays the an error indicating that there is no single search pattern supported by both the search plug-in and the selected filter/action plug-ins.

showStatusMessage

public void showStatusMessage(java.lang.String message)

Displays feedback to the user, such as in the status bar of a window.

setSearchRootUI

public void setSearchRootUI(SearchRootUIIfc root)

Installs the "panel" responsible for handling selection of the root location for the search to be performed.

getSaveToLocation

public java.io.File getSaveToLocation()

Displays a save dialog and returns the selection.

getOpenFromLocation

public java.io.File getOpenFromLocation()

Displays an open dialog and returns the selection.

showLoadError

public void showLoadError()

Display an error for the user indicating that the load process failed.

showConfirmInterrupt

public boolean showConfirmInterrupt()

Shows the user a confirmation prompt to determine if the currently executing search should be stopped.

disableForSearch

public void disableForSearch()

Tells the user interface to stop accepting user input for the duration of a search operation.

enableAfterSearch

public void enableAfterSearch()

Tells the user interface to start accepting user input at the completion of a search operation.

setActionsModel

public void setActionsModel(PluginCollection c)

Used to set a reference to the actions model within the ui.

setFiltersModel

public void setFiltersModel(PluginCollection c)

Used to set a reference to the filters model within the ui.

setFilterSummary

public void setFilterSummary(java.lang.String summary)

Sets a summary of the filters' configuration in the ui.

setActionSummary

public void setActionSummary(java.lang.String summary)

Sets a summary of the actions' configuration in the ui.

addFilterUI

public void addFilterUI(int index,
                        java.awt.Component c,
                        java.lang.String title)

Adds the filter's ui to the user interface.

addActionUI

public void addActionUI(int index,
                        java.awt.Component c,
                        java.lang.String title)

Adds the action's ui to the user interface.

removeFilterUI

public void removeFilterUI(java.awt.Component c)

Removes the ui of the filter specified by the index from the user interface.

removeActionUI

public void removeActionUI(java.awt.Component c)

Removes the ui of the filter specified by the index from the user interface.