001/* 002 * This file is part of McIDAS-V 003 * 004 * Copyright 2007-2018 005 * Space Science and Engineering Center (SSEC) 006 * University of Wisconsin - Madison 007 * 1225 W. Dayton Street, Madison, WI 53706, USA 008 * https://www.ssec.wisc.edu/mcidas 009 * 010 * All Rights Reserved 011 * 012 * McIDAS-V is built on Unidata's IDV and SSEC's VisAD libraries, and 013 * some McIDAS-V source code is based on IDV and VisAD source code. 014 * 015 * McIDAS-V is free software; you can redistribute it and/or modify 016 * it under the terms of the GNU Lesser Public License as published by 017 * the Free Software Foundation; either version 3 of the License, or 018 * (at your option) any later version. 019 * 020 * McIDAS-V is distributed in the hope that it will be useful, 021 * but WITHOUT ANY WARRANTY; without even the implied warranty of 022 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 023 * GNU Lesser Public License for more details. 024 * 025 * You should have received a copy of the GNU Lesser Public License 026 * along with this program. If not, see http://www.gnu.org/licenses. 027 */ 028 029package edu.wisc.ssec.mcidasv; 030 031import java.awt.Color; 032 033import ucar.unidata.idv.IdvConstants; 034import ucar.unidata.util.PatternFileFilter; 035 036/** 037 * Application wide constants. 038 */ 039public interface Constants extends IdvConstants { 040 041 /** Path to a skin that creates a window with an empty comp group. */ 042 String BLANK_COMP_GROUP = 043 "/edu/wisc/ssec/mcidasv/resources/skins/window/comptest.xml"; 044 045 /** Name of a thing that contains the data choosers and field selector. */ 046 String DATASELECTOR_NAME = "McIDAS-V - Data Explorer"; 047 048 /** 049 * A thing that contains one or more of the things named 050 * {@code PANEL_NAME}. One of these can be either in a tab 051 * or in it's own window. 052 */ 053 String DISPLAY_NAME = "Display"; 054 055 /** Name of a thing that contains the display/layer controls. */ 056 String DISPLAYCONTROLLER_NAME = "Display Controller"; 057 058 /** Macro for the build date. */ 059 String MACRO_BUILDDATE = "%BUILDDATE%"; 060 061 /** Macro for the copyright year in the about HTML file. */ 062 String MACRO_COPYRIGHT_YEAR = "%COPYRIGHT_YEAR%"; 063 064 /** Macro for the IDV version in the about HTML file. */ 065 String MACRO_IDV_VERSION = "%IDVVERSION%"; 066 067 /** Macro for the version in the about HTML file. */ 068 String MACRO_VERSION = "%MCVERSION%"; 069 070 /** Macro for the VisAD version in the about HTML file. */ 071 String MACRO_VISAD_VERSION = "%VISADVERSION%"; 072 073 /** Macro for granule count (only applies for swath data). */ 074 String MACRO_GRANULE_COUNT = "%granulecount%"; 075 076 /** Default size for GUI elements. */ 077 int ELEMENT_WIDTH = 90; 078 int GAP_RELATED = 6; 079 int GAP_UNRELATED = (GAP_RELATED * 2); 080 int ELEMENT_DOUBLE_WIDTH = ELEMENT_WIDTH * 2; 081 int ELEMENT_ONEHALF_WIDTH = (int)Math.round(ELEMENT_WIDTH * 1.5); 082 int ELEMENT_HALF_WIDTH = Math.round(ELEMENT_WIDTH / 2); 083 int ELEMENT_DOUBLEDOUBLE_WIDTH = (ELEMENT_DOUBLE_WIDTH * 2) + ELEMENT_WIDTH + (GAP_RELATED * 3) + 24; 084 085 /** 086 * Common line styles used in various UI controls 087 */ 088 089 String [] lineStyles = new String[] { "_____", "_ _ _", ".....", "_._._" }; 090 091 /** Icon locations for buttons. */ 092 String ICON_APPLY_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/action_go.gif"; 093 String ICON_ACCEPT_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/accept.png"; 094 String ICON_CANCEL_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/stop-loads16.png"; 095 String ICON_EXCLAMATION_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/exclamation.png"; 096 String ICON_INFORMATION_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/information.png"; 097 String ICON_ERROR_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/error.png"; 098 String ICON_HELP_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/show-help16.png"; 099 String ICON_ADD_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/add.png"; 100 String ICON_DELETE_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/delete.png"; 101 String ICON_CONNECT_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/connect.png"; 102 String ICON_DISCONNECT_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/disconnect.png"; 103 String ICON_UNDO_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/arrow_undo.png"; 104 String ICON_REDO_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/arrow_redo.png"; 105 String ICON_REFRESH_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/view-refresh16.png"; 106 String ICON_OPEN_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/document-open16.png"; 107 String ICON_SAVE_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/save-as-fave-bundle16.png"; 108 String ICON_SAVEAS_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/document-save16.png"; 109 String ICON_PREFERENCES_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/preferences-system16.png"; 110 String ICON_NEWWINDOW_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/application_add.png"; 111 String ICON_NEWTAB_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/tab_add.png"; 112 String ICON_NEXT_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/resultset_next.png"; 113 String ICON_PREVIOUS_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/resultset_previous.png"; 114 String ICON_RANDOM_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/view-refresh16.png"; 115 String ICON_HELPTIPS_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/dialog-information16.png"; 116 String ICON_CONSOLE_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/utilities-system-monitor16.png"; 117 String ICON_CHECKVERSION_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/preferences-desktop-multimedia16.png"; 118 String ICON_FORUMS_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/report_go.png"; 119 String ICON_SUPPORT_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/email_go.png"; 120 String ICON_DATAEXPLORER_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/mcidasv-round16.png"; 121 String ICON_LOCALDATA_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/show-data16.png"; 122 String ICON_COLORTABLE_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/x-office-presentation16.png"; 123 String ICON_LAYOUTEDIT_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/accessories-text-editor16.png"; 124 String ICON_RANGEANDBEARING_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/network-wireless16.png"; 125 String ICON_LOCATION_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/start-here16.png"; 126 String ICON_BACKGROUND_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/background-image16.png"; 127 String ICON_USERSGUIDE_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/book_open.png"; 128 String ICON_GETTINGSTARTED_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/book_next.png"; 129 String ICON_NOTE_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/note.png"; 130 String ICON_MCIDASV_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/mcidasv-round16.png"; 131 String ICON_MCIDASV_DEFAULT = "/edu/wisc/ssec/mcidasv/resources/icons/prefs/mcidasv-default-logo.png"; 132 133 String ICON_DEFAULTLAYOUT_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/key.png"; 134 String ICON_DEFAULTLAYOUTADD_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/key_add.png"; 135 String ICON_DEFAULTLAYOUTDELETE_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/key_delete.png"; 136 137 String ICON_REMOVE_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/edit-cut16.png"; 138 String ICON_REMOVELAYERS_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/remove-layers16.png"; 139 String ICON_REMOVEDATA_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/remove-data16.png"; 140 String ICON_REMOVELAYERSDATA_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/remove-layers-data16.png"; 141 142 String ICON_FAVORITE_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/fave-bundle16.png"; 143 String ICON_FAVORITESAVE_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/save-as-fave-bundle16.png"; 144 String ICON_FAVORITEMANAGE_SMALL = "/edu/wisc/ssec/mcidasv/resources/icons/buttons/manage-favorite16.png"; 145 146 String ICON_CANCEL = "/edu/wisc/ssec/mcidasv/resources/icons/toolbar/stop-load22.png"; 147 String ICON_HELP = "/edu/wisc/ssec/mcidasv/resources/icons/toolbar/show-help22.png"; 148 String ICON_REFRESH = "/edu/wisc/ssec/mcidasv/resources/icons/toolbar/view-refresh22.png"; 149 String ICON_UPDATE = "/edu/wisc/ssec/mcidasv/resources/icons/toolbar/system-software-update22.png"; 150 String ICON_OPEN = "/edu/wisc/ssec/mcidasv/resources/icons/toolbar/document-open22.png"; 151 String ICON_SAVE = "/edu/wisc/ssec/mcidasv/resources/icons/toolbar/document-save22.png"; 152 153 /** 154 * Java OS descriptor for the Max OSX operating system. This should be 155 * constant for any machine running java on OSX. 156 */ 157 String OS_OSX = "Mac OS X"; 158 159 /** 160 * Name of thing that contains the actual VisAD display, the animation 161 * control, view and projection menus, and the toolbar. 162 */ 163 String PANEL_NAME = "Panel"; 164 165 /** Server preference manager. */ 166 String PREF_LIST_ADDE_SERVERS = "ADDE Servers"; 167 168 /** Server state preference ID prefix. Holds the last server/group used. */ 169 String PREF_SERVERSTATE = "idv.chooser.adde.serverstate"; 170 171 /** 172 * The server/group to use if there is no value associated with 173 * {@link #PREF_SERVERSTATE}. 174 */ 175 String[] DEFAULT_SERVERSTATE = new String[] { "adde.ucar.edu", "RTIMAGES" }; 176 177 /** Advanced preferences for IDV, Java, and McIDAS-X. */ 178 String PREF_LIST_ADVANCED = "Advanced"; 179 180 /** Advanced preferences for IDV, Java, and McIDAS-X. */ 181 String PREF_LIST_LOCAL_ADDE = "Local Data"; 182 183 /** Preferences for which display types to allow. */ 184 String PREF_LIST_AVAILABLE_DISPLAYS = "Available Displays"; 185 186 /** Preferences for which data choosers should show up. */ 187 String PREF_LIST_DATA_CHOOSERS = "Data Sources"; 188 189 /** Name of panel containing preferences related to data formatting. */ 190 String PREF_LIST_FORMATS_DATA = "Formats & Data"; 191 192 /** Name of panel that holds the "general" sorts of user preferences. */ 193 String PREF_LIST_GENERAL = "General"; 194 195 /** Panel name for the different nav control scheme preferences. */ 196 String PREF_LIST_NAV_CONTROLS = "Navigation Controls"; 197 198 /** Pref for image chooser to include system servers. */ 199 String PREF_SYSTEMSERVERSIMG = 200 "mcidasv.chooser.adde.image.servers.system"; 201 202 /** Preferences for configuring what appears in the toolbar. */ 203 String PREF_LIST_TOOLBAR = "Toolbar Options"; 204 205 /** Name of different preferences for configuring how tabs/windows look. */ 206 String PREF_LIST_VIEW = "Display Window"; 207 208 /** Preference ID for limiting # of new windows when loading bundles. */ 209 String PREF_OPEN_LIMIT_WIN = "mcv.open.limitwin"; 210 211 /** Name of the version check user preference. */ 212 String PREF_VERSION_CHECK = "mcidasv.doversioncheck"; 213 214 /** Name of the pre-release check user preference. */ 215 String PREF_PRERELEASE_CHECK = "mcidasv.doprereleasecheck"; 216 217 /** Name of the {@literal "remove all data warning"} preference. */ 218 String PREF_CONFIRM_REMOVE_DATA = 219 "mcv.warn.remove.data.all"; 220 221 /** Name of the {@literal "remove all layers warning"} preference. */ 222 String PREF_CONFIRM_REMOVE_LAYERS = 223 "mcv.warn.remove.layers.all"; 224 225 /** Name of the {@literal "remove everything warning"} preference. */ 226 String PREF_CONFIRM_REMOVE_BOTH = 227 "mcv.warn.remove.everything"; 228 229 /** 230 * Preference for controlling the automated saving of the default layout. 231 */ 232 String PREF_AUTO_SAVE_DEFAULT_LAYOUT = "mcidasv.defaultlayout.autosave"; 233 234 String PREF_SAVE_DASHBOARD_VIZ = "mcidasv.dashboard.savevisibility"; 235 236 /** Preference for saving image preview default. */ 237 String PREF_IMAGE_PREVIEW = "mcidasv.chooser.adde.preview"; 238 239 /** 240 * Whether to show user VIIRS plugin compatibility check popup. 241 * Increment the counter below with each update of the plugin. 242 */ 243 int VIIRS_PLUGIN_VERSION_NUMBER = 2; 244 245 /** Alert user VIIRS plugin needs updating */ 246 String PREF_VIIRS_PLUGIN = 247 "mcidasv.viirs.pluginversion" + VIIRS_PLUGIN_VERSION_NUMBER; 248 249 /** Used to alert user they are modifying default color table */ 250 String PREF_MODIFY_DEFAULT_COLOR_TABLE = "mcidasv.default.colortable.modify"; 251 252 /** Whether or not to show the McIDAS-V {@literal "system"} bundles. */ 253 String PREF_SHOW_SYSTEM_BUNDLES = "mcidasv.showsystembundles"; 254 255 /** 256 * Show large or small icons. If PREF_TBM_ICONS is disabled, this pref 257 * has no meaning. 258 */ 259 String PREF_TBM_SIZE = "tbm.icon.size"; 260 261 /** Property name for for the path to about dialog template. */ 262 String PROP_ABOUTTEXT = "mcidasv.about.text"; 263 264 /** Path to the main McIDAS-V icon. */ 265 String PROP_APP_ICON = "mcidasv.window.icon"; 266 267 /** When was visad.jar built? */ 268 String PROP_VISAD_DATE = "visad.build.date"; 269 270 /** What version of VisAD lives within visad.jar? */ 271 String PROP_VISAD_REVISION = "visad.build.revision"; 272 273 /** Was there a problem determing VisAD's version? */ 274 String PROP_VISAD_PARSE_FAIL = "visad.build.parsefail"; 275 276 /** What exactly broke the version extraction? */ 277 String PROP_VISAD_ORIGINAL = "visad.build.contents"; 278 279 /** When was McIDAS-V built? */ 280 String PROP_BUILD_DATE = "mcidasv.build.date"; 281 282 /** Property name for the copyright year. */ 283 String PROP_COPYRIGHT_YEAR = "mcidasv.copyright.year"; 284 285 /** Property name for the McIDAS-V homepage URL. */ 286 String PROP_HOMEPAGE = "mcidasv.homepage"; 287 288 /** Specifies use of {@code edu.wisc.ssec.mcidasv.ui.TabbedUIManager}. */ 289 String PROP_TABBED_UI = "mcidasv.tabbedDisplay"; 290 291 /** Property name for the major version number. */ 292 String PROP_VERSION_MAJOR = "mcidasv.version.major"; 293 294 /** Property name for the minor version number. */ 295 String PROP_VERSION_MINOR = "mcidasv.version.minor"; 296 297 /** Property name for the version release number. */ 298 String PROP_VERSION_RELEASE = "mcidasv.version.release"; 299 300 /** Property name for the path to version file. */ 301 String PROP_VERSIONFILE = "mcidasv.version.file"; 302 303 /** Property that determines whether the view panel should pop up. */ 304 String PROP_VP_SHOWPOPUP = 305 "idv.ui.viewpanel.showpopup"; 306 307 /** Property for whether view panel categories will be shown. */ 308 String PROP_VP_SHOWCATS = 309 "idv.ui.viewpanel.showcategories"; 310 311 /** Typo was found in IDV code. */ 312 String PROP_VP_CATOPEN = "viewpanel.catgegory.open"; 313 314 /** 315 * Property used to restore the size and position of the dashboard upon 316 * start. 317 */ 318 String PROP_DASHBOARD_BOUNDS = "mcidasv.dashboard.bounds"; 319 320 /** Property used to store and retrieve color selection history. */ 321 String PROP_RECENT_COLORS = "mcidasv.colorchooser.recentcolors"; 322 323 /** 324 * Property used to store and retrieve the {@literal "0-360"} checkbox 325 * value. 326 */ 327 String PROP_HYDRA_360 = "mcidasv.hydra.multispectral.use360"; 328 329 /** 330 * Property indicating how many source granules made up a swath data 331 * source. 332 */ 333 String PROP_GRANULE_COUNT = "mcidasv.swath.granulecount"; 334 335 /** Application property file name. */ 336 String PROPERTIES_FILE = 337 "/edu/wisc/ssec/mcidasv/resources/mcidasv.properties"; 338 339 /** McIDAS-V base URL. */ 340 String HOMEPAGE_URL = "https://www.ssec.wisc.edu/mcidas/software/v"; 341 342 /** Location of latest version file under base URL. */ 343 String VERSION_URL = "stable/version.txt"; 344 String VERSION_HANDLER_URL = "stable/version.php"; 345 346 /** Location of latest pre-release directory under base URL. */ 347 String PRERELEASE_URL = "prerelease/"; 348 349 /** Location of latest notice file under base URL. */ 350 String NOTICE_URL = "stable/notice.txt"; 351 352 /** 353 * {@literal "Scrub strings"} are simple string substitutions for things 354 * like labels. 355 */ 356 String SCRUB_STRINGS_FILE = 357 "/edu/wisc/ssec/mcidasv/resources/scrubstrings.xml"; 358 359 /** Where to look for javahelp. */ 360 String DEFAULT_DOCPATH = "/docs/userguide"; 361 362 /** File suffix for bundle files. */ 363 String SUFFIX_MCV = ".mcv"; 364 365 /** File suffix for compressed bundle files. */ 366 String SUFFIX_MCVZ = ".mcvz"; 367 368 /** File filter used for bundle files. */ 369 PatternFileFilter FILTER_MCV = 370 new PatternFileFilter("(.+\\.mcv$)", 371 "McIDAS-V Bundles (*.mcv)", SUFFIX_MCV); 372 373 /** File filter used for bundle files. */ 374 PatternFileFilter FILTER_MCVZ = 375 new PatternFileFilter("(.+\\.mcvz$)", "McIDAS-V Zipped Data Bundles (*.mcvz)", SUFFIX_MCVZ); 376 377 /** File filter used for bundle files. */ 378 PatternFileFilter FILTER_MCVMCVZ = 379 new PatternFileFilter("(.+\\.mcv$|.+\\.mcvz$)", "All McIDAS-V Bundles (*.mcv,*.mcvz)", SUFFIX_MCV); 380 381 /** Default port for local ADDE servers. */ 382 String LOCAL_ADDE_PORT = "8112"; 383 384 String PROP_CHAN = "selectedchannel"; 385 386 /** Preference to store what ADDE servers to show. */ 387 String PROP_SERVERS = "idv.serverstoshow"; 388 389 /** Preference to store whether to show all ADDE servers. */ 390 String PROP_SERVERS_ALL = "idv.serverstoshow.all"; 391 392 /** Name to store the total system memory. */ 393 String PROP_SYSMEM = "idv.sysmem"; 394 395 /** Maximum amount of memory 32bit JREs can address, in megabytes. */ 396 int MAX_MEMORY_32BIT = 1536; 397 398 /** A particular shade of blue we are using for branding. */ 399 Color MCV_BLUE = new Color(96, 176, 224); 400 Color MCV_BLUE_DARK = new Color(0, 96, 255); 401 402 /** Identifier for the {@literal "monitor panel"} window component. */ 403 String COMP_MONITORPANEL = "mcv.monitorpanel"; 404 405 /** Default user directory name */ 406 String USER_DIRECTORY_NAME = "McIDAS-V"; 407 408 /** Tooltip for adaptive resolution menu items. */ 409 String TOOLTIP_PROGRESSIVE_RESOLUTION = "This feature can be turned on or off in the \"Display Window\" section of the User Preferences."; 410 411 /** EventBus topic for signaling that directory monitors may begin. */ 412 String EVENT_FILECHOOSER_START = "FileChooser.StartWatchService"; 413 414 /** EventBus topic for signaling that directory monitors should stop. */ 415 String EVENT_FILECHOOSER_STOP = "FileChooser.StopWatchService"; 416}