net.sf.jomic.common
Interface PropertyConstants


public interface PropertyConstants

Names and documentation of properties. These properties can either be set in the jomic.properties file, or specified at java command line using -Dnet.sf.jomic.*=value . Constants starting with DEFAULT_ indicate default values for certain properties, constants starting with TEST_ indicate names of properties that are used for testing. Such properties often show up in the productive part of the code (for example to throw test exceptions at awkward places to test error handling), so they are deliberately not defined in the (usually hidden) test source directory.

Author:
Thomas Aglassinger

Field Summary
static java.lang.String ADD_COMICS_TO_CONVERT_DIALOG_WINDOW
          Location and dimension of "Add comics to convert" dialog.
static java.lang.String ADJUST_ARCHIVE_SUFFIX
          If true, *.zip and *.rar archives will be renamed to *.cbz and *.cbr after opening.
static java.lang.String ARCHIVE_CACHE_SIZE_IN_MB
          Size of cache for extracted comic archives in MB.
static java.lang.String BLUR_MODE
          Blur mode.
static java.lang.String BLUR_RADIUS
          Number of adjacent pixels the blur should affect.
static java.lang.String BLUR_THRESHOLD
           
static int BROWSER_STARTUP_DELAY
          Milliseconds to wait before exit if web browser has just been started.
static java.lang.String CACHE_DIR
          Base directory where various caches are located.
static java.lang.String COMIC_WINDOW
          Location and dimension of comic window.
static java.lang.String CONVERSION_REPORT_WINDOW
          Location and dimension of "Conversion report" dialog.
static java.lang.String CONVERT_COMIC_DIALOG_WINDOW
          Location and dimension of "Convert comic" dialog.
static java.lang.String CONVERT_DIALOG_WINDOW
          Location and dimension of "Convert" dialog.
static java.lang.String CREATE_COMIC_FOR_EACH_SUB_FOLDER
          If true, "File > New" creates an own comic for each sub folder found in the folder specified.
static int DEFAULT_ARCHIVE_CACHE_SIZE_IN_MB
           
static int DEFAULT_BLUR_RADIUS
           
static int DEFAULT_BLUR_THRESHOLD
           
static int DEFAULT_DELAY
          Default delay in milliseconds waitSomeTime() waits if PROPERTY_JOMIC_DELAY is not set.
static int DEFAULT_FEW
           
static int DEFAULT_MOST_RECENT_PAGE
           
static int DEFAULT_RECENT_COUNT
           
static int DEFAULT_SCROLL_COUNT
           
static java.lang.String DEFAULT_SORT_MODE
           
static int DEFAULT_TILE_CACHE_SIZE_IN_MB
           
static java.lang.String DEFAULT_UNRAR
           
static java.lang.String EXPORT_ALL_IMAGES_DIALOG_WINDOW
          Location and dimension of "Export all images" dialog.
static java.lang.String EXPORT_IMAGE_DIALOG_WINDOW
          Location and dimension of "Export image" dialog.
static java.lang.String FEW
          Amount to consider "a few".
static java.lang.String GENERIC_FILE_CHOOSER_WINDOW
          Location and dimension of generic "Choose file" dialog.
static java.lang.String GO_TO_PAGE_DIALOG_WINDOW
          Location and dimension of "Go to page" dialog.
static java.lang.String HIDE_MNEMONICS
          True means that no menu mnemonics should be generated automatically.
static java.lang.String IGNORE_OSX
          If running on Mac OS X, this pretends that we are on some other platform.
static java.lang.String LAST_CREATE_COMIC_SOURCE_DIR
           
static java.lang.String LAST_CREATE_COMIC_TARGET_DIR
           
static java.lang.String LAST_EXPORT_ALL_IMAGES_DIR
           
static java.lang.String LAST_EXPORTED_IMAGE_DIR
           
static java.lang.String LOCALE
          The locale to use for the UI, specified as "language" or "language_country", for example "en" or "de_AT".
static java.lang.String LOG_STARTUP
          If true, Jomic/JomicMacOSX logs the early startup actions to System.out.
static java.lang.String MOST_RECENT_PAGE
          Page number in most recent comic, 0 refers to the title page, and -1 means there is no most recent page (for example in case there is no most recent comic because Jomic never has been launched before).
static java.lang.String NEW_COMIC_DIALOG_WINDOW
          Location and dimension of "New Comic" dialog.
static java.lang.String OPEN_DIALOG_WINDOW
          Location and dimension of "Open comic" dialog.
static java.lang.String OPEN_IN_FULL_SCREEN
          If true, the next comic opens in full screen.
static java.lang.String OPEN_NEW_COMIC
          If true, open comic created with "File > New" in viewer.
static java.lang.String RECENT_COUNT
           
static java.lang.String RECENT_PREFIX
           
static java.lang.String SCALE_MODE
           
static java.lang.String SCROLL_COUNT
          Number of pixels to scroll with one notch of the scroll wheel.
static java.lang.String SET_BLUR_DIALOG_WINDOW
          Location and dimension of "Blur settings" dialog.
static java.lang.String SET_CREATE_COMIC_SOURCE_DIR_DIALOG_WINDOW
          Location and dimension of "Set source image folder" dialog for "New comic" dialog.
static java.lang.String SET_CREATE_COMIC_TARGET_DIR_DIALOG_WINDOW
          Location and dimension of "Set target comic folder" dialog for "New comic" dialog.
static java.lang.String SETTINGS_DIR
          Directory in which settings are stored.
static java.lang.String SHOW_FRAMELESS_MENU_BAR
          Use the frameless menu bar under Mac OS X, so that Jomic stays open even if all comic windows where closed?
static java.lang.String SHOW_INFO
          Show information panel?
static java.lang.String SHOW_THUMBS
          Show thumb nails for pages?
static java.lang.String SHOW_TOOLBAR
          Show toolbar?
static java.lang.String SORT_MODE
          Sort mode for image names.
static java.lang.String SYSTEM_PROPERTY_PREFIX
          Prefix used for mapping system properties to Jomic properties.
static java.lang.String TEST_BEEP_ON_REPAINT
          Beep when starting repaint().
static java.lang.String TEST_DELAY
          Delay in milliseconds tests should use to show GUI elements before automatically closing them.
static java.lang.String TEST_IGNORE_EXIT
          If true, do not call System.exit() in JomicStartup.exit().
static java.lang.String TEST_IGNORE_MESSAGE_DIALOGS
          If true, error and warning message dialogs are suppressed and cancelled without user interaction, just logging a message.
static java.lang.String TEST_JOMIC_HOME
          The home directory where Jomic repository has been checked out to.
static java.lang.String TEST_KEEP_TEMP_FILES
          If true, temporary files created during testing will not be removed.
static java.lang.String TEST_NO_JAI
          If true, pretend JAI is not installed.
static java.lang.String TEST_PREFIX
          Prefix to be used with properties only relevant for testing.
static java.lang.String TEST_SHOW_FULL_SCREEN_IN_WINDOW
          It true, the full screen will actually show up in a window in order to make it easier to debug it from an IDE.
static java.lang.String TEST_SKIP_FULL_SCREEN_TEST
          If true, all tests involving full screen mode will be skipped.
static java.lang.String TILE_CACHE_SIZE_IN_MB
          JAI tile cache size in MB.
static java.lang.String USE_BLUR
           
 

Field Detail

ARCHIVE_CACHE_SIZE_IN_MB

static final java.lang.String ARCHIVE_CACHE_SIZE_IN_MB
Size of cache for extracted comic archives in MB.

See Also:
Constant Field Values

DEFAULT_DELAY

static final int DEFAULT_DELAY
Default delay in milliseconds waitSomeTime() waits if PROPERTY_JOMIC_DELAY is not set.

See Also:
Constant Field Values

SYSTEM_PROPERTY_PREFIX

static final java.lang.String SYSTEM_PROPERTY_PREFIX
Prefix used for mapping system properties to Jomic properties.

See Also:
Constant Field Values

IGNORE_OSX

static final java.lang.String IGNORE_OSX
If running on Mac OS X, this pretends that we are on some other platform.

See Also:
SystemTools.isMacOSX(), Constant Field Values

HIDE_MNEMONICS

static final java.lang.String HIDE_MNEMONICS
True means that no menu mnemonics should be generated automatically. This is useful on platforms that do not support menu mnemonics.

See Also:
UiTools.fillMnemonics(javax.swing.JMenu), UiTools.fillMnemonics(javax.swing.JMenuBar), Constant Field Values

TEST_PREFIX

static final java.lang.String TEST_PREFIX
Prefix to be used with properties only relevant for testing.

See Also:
Constant Field Values

DEFAULT_FEW

static final int DEFAULT_FEW
See Also:
Constant Field Values

DEFAULT_BLUR_RADIUS

static final int DEFAULT_BLUR_RADIUS
See Also:
Constant Field Values

DEFAULT_BLUR_THRESHOLD

static final int DEFAULT_BLUR_THRESHOLD
See Also:
Constant Field Values

DEFAULT_RECENT_COUNT

static final int DEFAULT_RECENT_COUNT
See Also:
Constant Field Values

DEFAULT_SCROLL_COUNT

static final int DEFAULT_SCROLL_COUNT
See Also:
Constant Field Values

DEFAULT_MOST_RECENT_PAGE

static final int DEFAULT_MOST_RECENT_PAGE
See Also:
Constant Field Values

DEFAULT_SORT_MODE

static final java.lang.String DEFAULT_SORT_MODE
See Also:
Constant Field Values

MOST_RECENT_PAGE

static final java.lang.String MOST_RECENT_PAGE
Page number in most recent comic, 0 refers to the title page, and -1 means there is no most recent page (for example in case there is no most recent comic because Jomic never has been launched before).

See Also:
Constant Field Values

DEFAULT_ARCHIVE_CACHE_SIZE_IN_MB

static final int DEFAULT_ARCHIVE_CACHE_SIZE_IN_MB
See Also:
Constant Field Values

DEFAULT_TILE_CACHE_SIZE_IN_MB

static final int DEFAULT_TILE_CACHE_SIZE_IN_MB
See Also:
Constant Field Values

DEFAULT_UNRAR

static final java.lang.String DEFAULT_UNRAR
See Also:
Constant Field Values

CACHE_DIR

static final java.lang.String CACHE_DIR
Base directory where various caches are located.

See Also:
Constant Field Values

COMIC_WINDOW

static final java.lang.String COMIC_WINDOW
Location and dimension of comic window.

See Also:
Constant Field Values

CREATE_COMIC_FOR_EACH_SUB_FOLDER

static final java.lang.String CREATE_COMIC_FOR_EACH_SUB_FOLDER
If true, "File > New" creates an own comic for each sub folder found in the folder specified.

See Also:
Constant Field Values

OPEN_NEW_COMIC

static final java.lang.String OPEN_NEW_COMIC
If true, open comic created with "File > New" in viewer.

See Also:
Constant Field Values

OPEN_DIALOG_WINDOW

static final java.lang.String OPEN_DIALOG_WINDOW
Location and dimension of "Open comic" dialog.

See Also:
Constant Field Values

GENERIC_FILE_CHOOSER_WINDOW

static final java.lang.String GENERIC_FILE_CHOOSER_WINDOW
Location and dimension of generic "Choose file" dialog. This just shows up if a FileChoosingPanel does not setup its own file chooser.

See Also:
Constant Field Values

ADD_COMICS_TO_CONVERT_DIALOG_WINDOW

static final java.lang.String ADD_COMICS_TO_CONVERT_DIALOG_WINDOW
Location and dimension of "Add comics to convert" dialog.

See Also:
Constant Field Values

SET_CREATE_COMIC_TARGET_DIR_DIALOG_WINDOW

static final java.lang.String SET_CREATE_COMIC_TARGET_DIR_DIALOG_WINDOW
Location and dimension of "Set target comic folder" dialog for "New comic" dialog.

See Also:
Constant Field Values

SET_CREATE_COMIC_SOURCE_DIR_DIALOG_WINDOW

static final java.lang.String SET_CREATE_COMIC_SOURCE_DIR_DIALOG_WINDOW
Location and dimension of "Set source image folder" dialog for "New comic" dialog.

See Also:
Constant Field Values

CONVERT_DIALOG_WINDOW

static final java.lang.String CONVERT_DIALOG_WINDOW
Location and dimension of "Convert" dialog.

See Also:
Constant Field Values

NEW_COMIC_DIALOG_WINDOW

static final java.lang.String NEW_COMIC_DIALOG_WINDOW
Location and dimension of "New Comic" dialog.

See Also:
Constant Field Values

CONVERSION_REPORT_WINDOW

static final java.lang.String CONVERSION_REPORT_WINDOW
Location and dimension of "Conversion report" dialog.

See Also:
Constant Field Values

CONVERT_COMIC_DIALOG_WINDOW

static final java.lang.String CONVERT_COMIC_DIALOG_WINDOW
Location and dimension of "Convert comic" dialog.

See Also:
Constant Field Values

EXPORT_IMAGE_DIALOG_WINDOW

static final java.lang.String EXPORT_IMAGE_DIALOG_WINDOW
Location and dimension of "Export image" dialog.

See Also:
Constant Field Values

EXPORT_ALL_IMAGES_DIALOG_WINDOW

static final java.lang.String EXPORT_ALL_IMAGES_DIALOG_WINDOW
Location and dimension of "Export all images" dialog.

See Also:
Constant Field Values

FEW

static final java.lang.String FEW
Amount to consider "a few". Used for example with the "next few" command.

See Also:
Constant Field Values

ADJUST_ARCHIVE_SUFFIX

static final java.lang.String ADJUST_ARCHIVE_SUFFIX
If true, *.zip and *.rar archives will be renamed to *.cbz and *.cbr after opening.

See Also:
Constant Field Values

GO_TO_PAGE_DIALOG_WINDOW

static final java.lang.String GO_TO_PAGE_DIALOG_WINDOW
Location and dimension of "Go to page" dialog.

See Also:
Constant Field Values

SET_BLUR_DIALOG_WINDOW

static final java.lang.String SET_BLUR_DIALOG_WINDOW
Location and dimension of "Blur settings" dialog.

See Also:
Constant Field Values

LOG_STARTUP

static final java.lang.String LOG_STARTUP
If true, Jomic/JomicMacOSX logs the early startup actions to System.out.

See Also:
Jomic, JomicMacOSX, Constant Field Values

RECENT_PREFIX

static final java.lang.String RECENT_PREFIX
See Also:
Constant Field Values

RECENT_COUNT

static final java.lang.String RECENT_COUNT
See Also:
Constant Field Values

SCALE_MODE

static final java.lang.String SCALE_MODE
See Also:
Constant Field Values

LAST_CREATE_COMIC_SOURCE_DIR

static final java.lang.String LAST_CREATE_COMIC_SOURCE_DIR
See Also:
Constant Field Values

LAST_CREATE_COMIC_TARGET_DIR

static final java.lang.String LAST_CREATE_COMIC_TARGET_DIR
See Also:
Constant Field Values

LAST_EXPORT_ALL_IMAGES_DIR

static final java.lang.String LAST_EXPORT_ALL_IMAGES_DIR
See Also:
Constant Field Values

LAST_EXPORTED_IMAGE_DIR

static final java.lang.String LAST_EXPORTED_IMAGE_DIR
See Also:
Constant Field Values

LOCALE

static final java.lang.String LOCALE
The locale to use for the UI, specified as "language" or "language_country", for example "en" or "de_AT".

See Also:
Constant Field Values

OPEN_IN_FULL_SCREEN

static final java.lang.String OPEN_IN_FULL_SCREEN
If true, the next comic opens in full screen.

See Also:
Constant Field Values

SCROLL_COUNT

static final java.lang.String SCROLL_COUNT
Number of pixels to scroll with one notch of the scroll wheel.

See Also:
Constant Field Values

SETTINGS_DIR

static final java.lang.String SETTINGS_DIR
Directory in which settings are stored. This is usefull to test Jomic with different settings without affecting the actual locally installed application.

See Also:
Constant Field Values

SHOW_FRAMELESS_MENU_BAR

static final java.lang.String SHOW_FRAMELESS_MENU_BAR
Use the frameless menu bar under Mac OS X, so that Jomic stays open even if all comic windows where closed?

See Also:
Constant Field Values

SHOW_INFO

static final java.lang.String SHOW_INFO
Show information panel?

See Also:
Constant Field Values

SHOW_THUMBS

static final java.lang.String SHOW_THUMBS
Show thumb nails for pages?

See Also:
Constant Field Values

USE_BLUR

static final java.lang.String USE_BLUR
See Also:
Constant Field Values

BLUR_RADIUS

static final java.lang.String BLUR_RADIUS
Number of adjacent pixels the blur should affect.

See Also:
Constant Field Values

BLUR_THRESHOLD

static final java.lang.String BLUR_THRESHOLD
See Also:
Constant Field Values

BLUR_MODE

static final java.lang.String BLUR_MODE
Blur mode.

See Also:
ImageTools.isValidBlurMode(String), Constant Field Values

SHOW_TOOLBAR

static final java.lang.String SHOW_TOOLBAR
Show toolbar?

See Also:
Constant Field Values

SORT_MODE

static final java.lang.String SORT_MODE
Sort mode for image names.

See Also:
FileTools.sort(String[], String), Constant Field Values

TILE_CACHE_SIZE_IN_MB

static final java.lang.String TILE_CACHE_SIZE_IN_MB
JAI tile cache size in MB.

See Also:
Constant Field Values

TEST_SKIP_FULL_SCREEN_TEST

static final java.lang.String TEST_SKIP_FULL_SCREEN_TEST
If true, all tests involving full screen mode will be skipped. This is useful to test in the background because these tests otherwise take over the whole screen and prevent the developer for continuing to work in the foreground.

See Also:
Constant Field Values

TEST_BEEP_ON_REPAINT

static final java.lang.String TEST_BEEP_ON_REPAINT
Beep when starting repaint(). This enables to hear redundant repaints and also allows to get a rough feeling for how long it takes from the start of repaint() to actually seeing the updated display.

See Also:
Constant Field Values

TEST_DELAY

static final java.lang.String TEST_DELAY
Delay in milliseconds tests should use to show GUI elements before automatically closing them.

See Also:
Constant Field Values

TEST_IGNORE_EXIT

static final java.lang.String TEST_IGNORE_EXIT
If true, do not call System.exit() in JomicStartup.exit().

See Also:
JomicStartup.exit(int), Constant Field Values

TEST_IGNORE_MESSAGE_DIALOGS

static final java.lang.String TEST_IGNORE_MESSAGE_DIALOGS
If true, error and warning message dialogs are suppressed and cancelled without user interaction, just logging a message.

See Also:
JomicTools.showError(JFrame, String, Throwable), Constant Field Values

TEST_NO_JAI

static final java.lang.String TEST_NO_JAI
If true, pretend JAI is not installed.

See Also:
Constant Field Values

TEST_SHOW_FULL_SCREEN_IN_WINDOW

static final java.lang.String TEST_SHOW_FULL_SCREEN_IN_WINDOW
It true, the full screen will actually show up in a window in order to make it easier to debug it from an IDE.

See Also:
Constant Field Values

TEST_JOMIC_HOME

static final java.lang.String TEST_JOMIC_HOME
The home directory where Jomic repository has been checked out to. This should have the same value as the environment variable $JOMIC_HOME, which is described in the Developer Guide .

See Also:
Constant Field Values

TEST_KEEP_TEMP_FILES

static final java.lang.String TEST_KEEP_TEMP_FILES
If true, temporary files created during testing will not be removed. This is useful if the contents of these files can help to track down a bug.

See Also:
Constant Field Values

BROWSER_STARTUP_DELAY

static final int BROWSER_STARTUP_DELAY
Milliseconds to wait before exit if web browser has just been started.

See Also:
Constant Field Values