6734 add comments to new methods

This commit is contained in:
William Schaefer 2021-06-11 10:46:52 -04:00
parent 3dd90ece00
commit 1772203287
2 changed files with 18 additions and 0 deletions

View File

@ -248,6 +248,15 @@ final class DataSourceBrowser extends javax.swing.JPanel implements ExplorerMana
return explorerManager;
}
/**
* Populate the data source browser with an updated list of the data sources
* and information about them.
*
* @param dsSummaryDialog The dialog which contains this data source
* browser panel.
* @param selectedDataSourceId The object id for the data source which
* should be selected.
*/
void populateBrowser(DataSourceSummaryDialog dsSummaryDialog, Long selectedDataSourceId) {
dsSummaryDialog.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
if (rootNodeWorker != null && !rootNodeWorker.isDone()) {
@ -275,6 +284,10 @@ final class DataSourceBrowser extends javax.swing.JPanel implements ExplorerMana
rootNodeWorker.execute();
}
/**
* Cancel the worker that updates the data source summary list and updates
* the data source summary browser.
*/
void cancel() {
if (rootNodeWorker != null && !rootNodeWorker.isDone()) {
rootNodeWorker.cancel(true);

View File

@ -161,6 +161,11 @@ final class DataSourceSummaryDialog extends javax.swing.JDialog implements Obser
private javax.swing.JSplitPane dataSourceSummarySplitPane;
// End of variables declaration//GEN-END:variables
/**
* Populate the data source browser with the specified data source selected.
*
* @param selectedDataSource The data source which should be selected in the data source browser.
*/
void populatePanel(Long selectedDataSource) {
dataSourcesPanel.populateBrowser(this, selectedDataSource);
}