public interface GuiIfc
Note that any implementer of this interface is also required to:
public static Object showSplashScreen()
which creates a start-up splash screen and returns a handle
to it so it can be taken down later with the disposeOfSplash(Object) method
on the GuiIfc implementer.| Modifier and Type | Interface and Description |
|---|---|
static interface |
GuiIfc.MapFunctor
Declare a callback for operations that have to iterate over all map windows, not just the current one.
|
static class |
GuiIfc.MessagingParams
Data structure containing parameters needed to transmit a text message.
|
static class |
GuiIfc.OsmImportParams
Data structure of parameters needed for the OpenStreetMap import operation.
|
static class |
GuiIfc.TileDownloadParams
Data structure of parameters needed for the OpenStreetMap pre-imported tile download operation.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addSpecificTrackStripe(java.lang.String identifier)
Add the identifier of a single station or object whose track stripe is to be plotted.
|
void |
approveTacticalSender(java.lang.String originatingCallsign,
java.lang.String tacticalMsgText)
Queue up a request to ask the user whether this TACTICAL message should be accepted and
processed.
|
void |
checkForUpdates(boolean interactive)
Check whether a newer release of YAAC is available, displaying status.
|
void |
clearAllSpecificTrackStripes()
Clear the plotting of all specific station/object track stripes.
|
void |
closeCurrentWindow()
Close the window that currently has the keyboard focus (if it is part of the YAAC application).
|
void |
composeWinlinkMessage()
Display a form to allow transmitting a multi-line email message to someone via the APRS-WinLink gateways.
|
void |
confirmSendBroadcastQuery(java.lang.String confirmTag,
java.lang.String query)
Broadcast a specified global query message after confirming the user really wants to send it.
|
void |
connectToStation()
Set up a dumb-terminal connection to an old-style packet BBS.
|
StatusListener |
createProgressReporter(java.lang.String title,
boolean modal)
Open whatever the local operating system uses for a progress dialog and
return an interface to send progress information to the dialog.
|
void |
displayAttentionAlert(double latitude,
double longitude,
AX25Message.Precedence precedence)
Display an AttentionAlert (flashing arrows) on the map for a particular station or object.
|
void |
displayAttentionAlert(StationState ss)
Display an AttentionAlert (flashing arrows) on the map for a particular station or object.
|
java.lang.Object[] |
displayHeardByDialog(StationState[] stationsToPickFrom)
Display a dialog asking for the parameters for a Heard-By (?APRSH) query.
|
void |
displayHelp(java.lang.String startingHelpId,
java.lang.Object parentWindow)
Launch the JavaHelp browser, starting with the help corresponding to the specified help ID
|
GuiIfc.MessagingParams |
displayMessagingDialog(java.util.ArrayList ssList)
Display a dialog asking the user for the parameters needed to send a text message to
another station.
|
GuiIfc.OsmImportParams |
displayOsmImportDialog(java.io.File osmFileDir)
Ask the user how and where from to import an OpenStreetMap compressed data file.
|
void |
displayOsmMirrorSiteList()
Display a popup with buttons to launch the user's web browser pointed at any of the
major download sites for raw OpenStreetMap data.
|
GuiIfc.TileDownloadParams |
displayOsmTileDownloadDialog(ChangeSet localChangeSet,
ChangeSet serverChangeSet)
Display a dialog asking the user which pre-compiled OSM tiles to download.
|
GuiIfc.TileDownloadParams |
displayTopoTileDownloadDialog(java.io.File tileDir)
Display a dialog asking the user which SRTM tiles to download.
|
void |
disposeOfSplash(java.lang.Object oSplash)
Get rid of the splash screen.
|
void |
editStationNotes(StationState station,
int mouseX,
int mouseY)
Display and edit notes attached to a specific station or object.
|
boolean |
ensureKeystoreIsOpen(boolean dontBlock)
Test if keystore has been opened with the correct password.
|
java.lang.Object |
getCurrentlyFocusedView()
Get the UI platform top-level widget that currently holds the focus.
|
java.lang.Object |
getCurrentTopLevelView()
Get the UI platform top-level widget that currently holds the focus, skipping child dialogs.
|
GeoMapIfc |
getMainMap()
Get the primary or default map display.
|
int |
getMessageCount()
Get the number of APRS Messages collected by the application.
|
SaveableTable |
getSaveableTableInView(java.lang.Object view)
Get the SaveableTable (if any) in the specified view.
|
void |
initializeWindowMenu(java.lang.Object item,
java.lang.Object view)
Create the entries on the dynamic Window menu on the menu bar corresponding to every window
except the one containing the menu bar.
|
void |
initMainWindowMenuBar()
Phase 2 of initializing the GUI (stuff that needs the GUI property of the main YAAC
object to be already initialized).
|
void |
invokeConfigWizard()
Start the configuration wizard at its first window.
|
void |
invokeObjectEditor(java.lang.String dialogTitleTag,
Message or,
int mouseX,
int mouseY,
ObjectReportTransmitter tx)
Display the Object editing dialog, possibly initialized with the contents of an existing
ObjectReport.
|
boolean |
isMemoryGCPanelVisible()
Report the current visibility of the MemoryGCPanel.
|
boolean |
isNightMode()
Report if the displays are in night mode.
|
boolean |
isSpecificallyTracked(java.lang.String identifier)
Test if a given identifier is on the tracking list.
|
boolean |
isSpecificallyTracking()
Test if any identifiers are on the tracking list.
|
boolean |
isViewPrintable(java.lang.Object o,
int depthLeft)
Test if specified GUI view is printable.
|
void |
iterateOverAllMaps(GuiIfc.MapFunctor functor)
Apply the functor to every currently open map window.
|
void |
loadAprsPackets()
Query the user for a file from which to load saved APRS messages.
|
void |
loadObjectsFromFile()
Load APRS Object definitions from a user-specified file.
|
void |
loadTacticalNames()
Load alias names and symbol codes for station callsigns and object names.
|
StationState |
pickAStation(java.util.ArrayList<StationState> matchList,
java.lang.String titleTag)
Select one of several stations.
|
void |
printWindow()
Print the window that currently has the focus.
|
boolean |
removeSpecificTrackStripe(java.lang.String identifier)
Remove the identifier of a single station or object whose track stripe is no longer to be plotted.
|
void |
saveAprsPackets()
Query the user for a file in which to save the current visible set of APRS messages.
|
void |
saveObjectsToFile()
Save the currently known APRS Objects to a file.
|
void |
saveTacticalNames()
Save alias names and symbol codes for station callsigns and object names.
|
void |
scheduleToGuiThread(java.lang.Runnable r)
Schedule a short-running operation that should only occur on the GUI dispatch
thread (however the implementing GUI chooses to do it).
|
java.io.File |
selectFileForWrite(java.io.File dir,
java.lang.String fileExtensionTag,
java.lang.String fileExtension)
Open a file selection dialog for saving a file.
|
int |
selectOneOf(java.lang.String title,
java.lang.String[] choices)
Create a popup dialog to ask the user which of several choices should be used.
|
java.lang.Object |
selectStation(java.lang.String titleBarTag,
boolean stationsOnly)
Select one station (or object, if allowed) from the currently known list, or allow
the user to manually type in a station callsign-SSID, and return the user selected value.
|
void |
sendQRU()
Broadcast a specified QRU query message after confirming the user really wants to send it.
|
void |
setMainFrameTitle()
Specify the title displayed in the main window's title bar.
|
void |
setMemoryGCPanelVisible(boolean visible)
Change the visibility of the memory usage status monitor for all map windows.
|
void |
setNightMode(boolean isNight)
Specify that the displays should be in night mode (black backgrounds with white text/lines, for not
ruining the night vision of the operator).
|
void |
showAboutDialog()
Display the About dialog for the YAAC application.
|
void |
showBandwidthMonitor()
Display a bandwidth monitor for each open I/O port in YAAC.
|
void |
showBulletinBoard()
Display the window used to display bulletin messages, and compose locally originated bulletins for transmission.
|
void |
showConfigurationDialog()
Start the regular configuration dialog.
|
void |
showConnectionReport()
Display outstanding connected (I-frame) AX.25 sessions.
|
void |
showDXReports()
Show a table view of all DX reports received by this station.
|
void |
showEditBlacklistDialog()
Generate and display the blacklist editor.
|
void |
showEditFilterDialog(Filter mainFilter,
java.lang.String dialogTitleTag)
Generate and display the filter dialog.
|
int |
showGenericConfirmDialog(java.lang.String titleTag,
java.lang.String msg)
Show a generic retry/skip/cancel dialog, with the specified title and
message text.
|
void |
showGenericErrorDialog(java.lang.String titleTag,
java.lang.String msg)
Show a generic error message dialog, with the specified title and
message text.
|
void |
showGenericInfoDialog(java.lang.String titleTag,
java.lang.String msg)
Show a generic informational message dialog, with the specified title and
message text.
|
java.lang.String |
showGenericInputDialog(java.lang.String titleTag,
java.lang.String msg)
Show a generic text input dialog, with the specified title and
message text.
|
int |
showGenericQuestionDialog(java.lang.String titleTag,
java.lang.String msg)
Show a generic yes/no question dialog, with the specified title and
message text.
|
int |
showGenericQuestionDialogWithHelp(java.lang.String titleTag,
java.lang.String msg)
Show a generic yes/no question dialog, with the specified title and
message text.
|
void |
showGpsStatusDialog()
Display a monitor of the current status of all GPS receivers connected to YAAC.
|
void |
showHealthMonitorReport()
Show the current station health reports for all remote stations being monitored.
|
void |
showHeardList()
Display a report of number of packets received from each station (or about each APRS Object/Item) over 15 minute
intervals in the YAAC history.
|
void |
showHistory(StationState ss)
Display the message history for a specified station or object.
|
void |
showIOFailureDialog(PortConfig config,
java.lang.String reason,
PortFailureReportListener listener)
Display an asynchronous non-blocking dialog on the screen to report an I/O error.
|
void |
showKeys()
Show a table view of the keys used to authenticate and verify the
integrity of signed messages.
|
void |
showLocalObjects()
Display a table of all Objects/Items being transmitted by this station.
|
void |
showMap()
Make visible and foreground the map window.
|
void |
showMessageFilterPane()
Display the window used for receiving and logging filtered text messages.
|
void |
showMessageFrame()
Open the MessageFrame (window displaying text message traffic in a table) and move it to the foreground.
|
void |
showOutstandingMessages()
Display the window showing all messages (except beacons and status messages) pending for transmission from the local station.
|
void |
showPluginStore()
Display a dialog for selecting new officially supported plugins to install.
|
void |
showRadioView(Message msg,
java.lang.String identifier)
Show the dialog that looks like the Kenwood D710 control head APRS display.
|
void |
showRawPacketFrame()
Display the raw packet window.
|
void |
showReleaseNotes()
Display the release notes history for the YAAC application.
|
void |
showStationList()
Show the window listing all the stations and objects heard by this station.
|
void |
showTelemetryReport()
Display all the current telemetry data heard by this station.
|
void |
showTXIGatedStations()
Show a table view of the stations currently being Tx I-gated by this station.
|
void |
showWeatherDialog()
Display a monitor of the current conditions reported by the local weather station attached to YAAC.
|
void |
startChatSession(java.lang.String callsign)
Open a Chat session window pointed at the specified remote station.
|
void setMainFrameTitle()
void disposeOfSplash(java.lang.Object oSplash)
oSplash - Object wrapped around the splash screenvoid initMainWindowMenuBar()
GeoMapIfc getMainMap()
void iterateOverAllMaps(GuiIfc.MapFunctor functor)
functor - MapFunctor to be iteratively calledint getMessageCount()
void invokeConfigWizard()
void showConfigurationDialog()
StatusListener createProgressReporter(java.lang.String title, boolean modal)
title - already-localized title String for the dialogmodal - whether the dialog should be application-modal or modelessvoid initializeWindowMenu(java.lang.Object item,
java.lang.Object view)
item - Object corresponding to the Window menuview - GUI window object containing the menu barvoid showGenericErrorDialog(java.lang.String titleTag,
java.lang.String msg)
titleTag - String tag to look up locale-specific dialog titlemsg - already-localized and variable-substituted error message text Stringvoid showGenericInfoDialog(java.lang.String titleTag,
java.lang.String msg)
titleTag - String tag to look up locale-specific dialog titlemsg - already-localized and variable-substituted error message text Stringint showGenericQuestionDialog(java.lang.String titleTag,
java.lang.String msg)
titleTag - String tag to look up locale-specific dialog titlemsg - already-localized and variable-substituted error message text Stringint showGenericQuestionDialogWithHelp(java.lang.String titleTag,
java.lang.String msg)
titleTag - String tag to look up locale-specific dialog titlemsg - already-localized and variable-substituted error message text Stringjava.lang.String showGenericInputDialog(java.lang.String titleTag,
java.lang.String msg)
titleTag - String tag to look up locale-specific dialog titlemsg - already-localized and variable-substituted error message text Stringint showGenericConfirmDialog(java.lang.String titleTag,
java.lang.String msg)
titleTag - String tag to look up locale-specific dialog titlemsg - already-localized and variable-substituted error message text Stringvoid setNightMode(boolean isNight)
isNight - boolean true if should be in night modeboolean isNightMode()
void showAboutDialog()
void showReleaseNotes()
boolean ensureKeystoreIsOpen(boolean dontBlock)
dontBlock - boolean true if this method should return immediately without blockingjava.lang.Object selectStation(java.lang.String titleBarTag,
boolean stationsOnly)
titleBarTag - String tag for localized title to display in popup dialogstationsOnly - boolean true if entries appearing only as Objects/Items should be excluded
from the pick listint selectOneOf(java.lang.String title,
java.lang.String[] choices)
title - String title to display in dialog box titlechoices - array of String choices to choose fromvoid loadAprsPackets()
void saveAprsPackets()
SaveableTable getSaveableTableInView(java.lang.Object view)
view - top-level window or view to be testedvoid showMap()
void displayOsmMirrorSiteList()
GuiIfc.OsmImportParams displayOsmImportDialog(java.io.File osmFileDir)
osmFileDir - File pointing at the directory to initially look for importable OSM data filesGuiIfc.TileDownloadParams displayOsmTileDownloadDialog(ChangeSet localChangeSet, ChangeSet serverChangeSet)
localChangeSet - the OSM ChangeSet of the last data downloaded or imported here (or null if
OSM data was never installed)serverChangeSet - the OSM ChangeSet currently available on the YAAC websiteGuiIfc.TileDownloadParams displayTopoTileDownloadDialog(java.io.File tileDir)
tileDir - File pointing at the directory where tiles are keptjava.io.File selectFileForWrite(java.io.File dir,
java.lang.String fileExtensionTag,
java.lang.String fileExtension)
dir - File for the initial directoryfileExtensionTag - String tag for looking up localized string of file type descriptionfileExtension - String file typevoid showRawPacketFrame()
void showMessageFrame()
void showMessageFilterPane()
void showBulletinBoard()
void showOutstandingMessages()
void showBandwidthMonitor()
void showGpsStatusDialog()
void showWeatherDialog()
void showHeardList()
void showConnectionReport()
void showRadioView(Message msg, java.lang.String identifier)
msg - a historical APRS Message to display, or null to display current real-time dataidentifier - the originating station callsign associated with the historical message (ignored if null msg)void showStationList()
void showLocalObjects()
void showHistory(StationState ss)
ss - StationState of the desired station or objectvoid showTelemetryReport()
void showHealthMonitorReport()
void showTXIGatedStations()
void showKeys()
void showDXReports()
void showEditFilterDialog(Filter mainFilter, java.lang.String dialogTitleTag)
mainFilter - the top Filter in the Filter hierarchydialogTitleTag - bundle tag for title to display on dialogvoid showEditBlacklistDialog()
void loadObjectsFromFile()
void saveObjectsToFile()
void loadTacticalNames()
void saveTacticalNames()
void displayAttentionAlert(StationState ss)
ss - StationState of the station or object to highlightvoid displayAttentionAlert(double latitude,
double longitude,
AX25Message.Precedence precedence)
latitude - double fractional degrees Northlongitude - double fraction degrees Eastprecedence - Precedence of the event to be reportedvoid composeWinlinkMessage()
void connectToStation()
void confirmSendBroadcastQuery(java.lang.String confirmTag,
java.lang.String query)
confirmTag - tag for resource file message for the confirmation queryquery - the actual APRS message to send (must be valid according to the APRS protocol specification)void approveTacticalSender(java.lang.String originatingCallsign,
java.lang.String tacticalMsgText)
originatingCallsign - callsign String of message originatortacticalMsgText - String of text message body (the TACTICAL directive)void sendQRU()
void invokeObjectEditor(java.lang.String dialogTitleTag,
Message or,
int mouseX,
int mouseY,
ObjectReportTransmitter tx)
dialogTitleTag - String tag for localized title to display on dialog title baror - APRS Message to initialize the editor, or null for creating an object from scratchmouseX - window X coordinate of mouse click (to generate initial coordinates), or -1 to not init position from mapmouseY - window Y coordinate of mouse click (to generate initial coordinates), or -1 to not init position from maptx - ObjectReportTransmitter to give any created or updated objects tovoid showIOFailureDialog(PortConfig config, java.lang.String reason, PortFailureReportListener listener)
config - PortConfig object describing the port with the problemreason - String describing why the port is downlistener - I/O subsystem that wants to be informed if the user dismisses the dialogvoid closeCurrentWindow()
StationState pickAStation(java.util.ArrayList<StationState> matchList, java.lang.String titleTag)
matchList - ArrayList of StationState objects to pick fromtitleTag - String name of resource tag for title of prompting dialogvoid scheduleToGuiThread(java.lang.Runnable r)
r - Runnable to be scheduled as soon as possible on the GUI threadjava.lang.Object getCurrentlyFocusedView()
java.lang.Object getCurrentTopLevelView()
void editStationNotes(StationState station, int mouseX, int mouseY)
station - StationState whose notes should be editedmouseX - window X coordinate of mouse click (to generate initial coordinates), or -1 to not init position from mapmouseY - window Y coordinate of mouse click (to generate initial coordinates), or -1 to not init position from mapboolean isViewPrintable(java.lang.Object o,
int depthLeft)
o - Object of view containerdepthLeft - number of levels of recursion allowed for the searchprintWindow()void printWindow()
isViewPrintable(Object, int)void setMemoryGCPanelVisible(boolean visible)
visible - boolean true if memory status monitor should be visibleboolean isMemoryGCPanelVisible()
java.lang.Object[] displayHeardByDialog(StationState[] stationsToPickFrom)
stationsToPickFrom - array of StationState objects specifying the list of
stations to choose from, or null to get all currently known
stationsGuiIfc.MessagingParams displayMessagingDialog(java.util.ArrayList ssList)
ssList - list of stations to populate the list with, or null for entire list of known stationsvoid startChatSession(java.lang.String callsign)
callsign - String callsign of the remote stationvoid displayHelp(java.lang.String startingHelpId,
java.lang.Object parentWindow)
startingHelpId - String help ID corresponding to an entry in a *.jhm file; null indicates the
top of the TOC view, empty string indicates the top of the Index viewparentWindow - window to parent an incarnation of the HelpBrokervoid checkForUpdates(boolean interactive)
interactive - boolean true if no-upgrade-needed status should be reported (out-of-date status is always reported)void showPluginStore()
void clearAllSpecificTrackStripes()
void addSpecificTrackStripe(java.lang.String identifier)
identifier - String station or object identifierboolean removeSpecificTrackStripe(java.lang.String identifier)
identifier - String station or object identifierboolean isSpecificallyTracked(java.lang.String identifier)
identifier - String station or object identifierboolean isSpecificallyTracking()