|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface describing the action of a dialogue with which the user can interact to specify a new table to load.
LoadWorker
Method Summary | |
String |
getDescription()
Description of this dialogue. |
String |
getName()
Name of this dialogue. |
boolean |
isAvailable()
Indicates whether this dialog can be invoked. |
boolean |
showLoadDialog(Component parent,
StarTableFactory factory,
ComboBoxModel formatModel,
TableConsumer consumer)
Presents the user with a dialogue which may be used to specify a table to load. |
Method Detail |
public boolean showLoadDialog(Component parent, StarTableFactory factory, ComboBoxModel formatModel, TableConsumer consumer)
In the event that true is returned, the implementation of this
method should ensure that notification of the table load attempt
should be made to the consumer argument
using the defined TableConsumer
methods.
The purpose of doing it like this
(rather than just returning a StarTable from this method)
is so that the table loading, which may be time-consuming,
can be done in a thread other than the event dispatch thread
on which this method will have been called.
The LoadWorker
class is provided to assist with this;
the usual idiom for performing the load from the event dispatch
thread within the implementation of this method looks like this:
new LoadWorker( tableConsumer, tableId ) { protected StarTable attemptLoad() throws IOException { return tableFactory.makeStarTable( ... ); } }.invoke();
Error conditions during the course of the user interaction by this method should in general be dealt with by informing the user (e.g. with a popup) and permitting another attempt. Some sort of cancel button should be provided which should trigger return with a false result.
The formatModel argument may be used to determine or
set the format to be used for interpreting tables.
Its entries are Strings, and in general the selected one
should be passed as the handler argument to one of
factory's makeStarTable methods.
The dialogue may wish to allow the user to modify the selection
by presenting a JComboBox
based on this model.
A suitable model can be obtained using
TableLoadChooser.makeFormatBoxModel(uk.ac.starlink.table.StarTableFactory)
.
parent
- parent windowfactory
- factory which may be used for table creationformatModel
- comboBoxModelconsumer
- object which can do something with the loaded table
public String getName()
Action.NAME
)
which invokes showLoadDialog.
public String getDescription()
Action.SHORT_DESCRIPTION
)
which invokes showLoadDialog
public boolean isAvailable()
showLoadDialog(java.awt.Component, uk.ac.starlink.table.StarTableFactory, javax.swing.ComboBoxModel, uk.ac.starlink.table.gui.TableConsumer)
,
but is not guaranteed to be invoked again.
|
Copyright © 2004 CLRC: Central Laboratory of the Research Councils. All rights reserved. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |