|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TableLoadDialog
Interface for an object which can handle the user interaction for selecting a table or tables to load.
Method Summary | |
---|---|
void |
configure(StarTableFactory tfact,
Action submitAct)
Provides some configuration which must be performed before use. |
TableLoader |
createTableLoader()
Returns a new object which specifies how table loading is to be performed. |
String |
getDescription()
Returns a short description of this dialogue. |
Icon |
getIcon()
Returns an icon associated with this dialogue. |
JMenu[] |
getMenus()
Returns an array of menus which may be presented in the window alongside the query component. |
String |
getName()
Returns the name of this dialogue. |
Component |
getQueryComponent()
Returns the GUI component which allows the user to select how tables are to be loaded. |
Action |
getSubmitAction()
Returns the action set by configure(uk.ac.starlink.table.StarTableFactory, javax.swing.Action) . |
Action[] |
getToolbarActions()
Returns an array of actions suitable for presentation as toolbar buttons alongside the query component. |
boolean |
isAvailable()
Indicates whether this dialogue may be used. |
Method Detail |
---|
String getName()
Action.NAME
).
String getDescription()
Action.SHORT_DESCRIPTION
).
Icon getIcon()
Component getQueryComponent()
JMenu[] getMenus()
Action[] getToolbarActions()
boolean isAvailable()
void configure(StarTableFactory tfact, Action submitAct)
getQueryComponent()
is called.
The tfact
argument provides a table factory which
resembles the one to be used for generating tables.
Although this factory should not in general be used or retained,
since the one presented later to the TableLoader should be used
instead, it can be interrogated for known table formats etc.
The submitAct
argument sets the action which
when invoked will cause createTableLoader()
to be called.
Its setEnabled method can be called to reflect readiness,
and it can be added as a listener to dialogue-specific events
which indicate that a selection has been made.
tfact
- representative table factorysubmitAct
- action for load submissionAction getSubmitAction()
configure(uk.ac.starlink.table.StarTableFactory, javax.swing.Action)
.
TableLoader createTableLoader()
If the dialogue is not in a suitable state, either return null, or, if you want to provide more detailed information about what's wrong, throw a RuntimeException with an informative message.
|
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 |