org.icepdf.ri.util.ViewerPropertiesManager Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of icepdf-viewer Show documentation
Show all versions of icepdf-viewer Show documentation
ICEpdf Java Swing/AWT reference implementation.
/*
* Copyright 2006-2019 ICEsoft Technologies Canada Corp.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an "AS
* IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
package org.icepdf.ri.util;
import javax.swing.*;
import java.io.*;
import java.net.URL;
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.prefs.BackingStoreException;
import java.util.prefs.InvalidPreferencesFormatException;
import java.util.prefs.Preferences;
/**
* This class provides a wrapper for persisting the viewer ri's settings. The class also provides mechanisms for
* loading default properties. The class is divided into two sub concepts; the first being local properties (not sticky)
* that are only persisted by command and the second being a preferences object that automatically saves values (sticky).
*
* Local Properties
* The SwingViewBuilder uses local properties to build the AWT Viewer. The viewer will always have a default state
* which can be altered with the checkAndStore*Property() methods. A given viewer configuration state can be persisted
* to the preference object with a call to saveStoreProperties(). Once local properties are persisted the only way
* to restore the default state is to call clearPreferences() or configure a customer ICEpdfDefault.properties file.
*
*
* Preferences
* The preferences object can be directly accessed via the accessor to directly access the preference api.
*
*
* Default Properties
* The default viewer ri ships with a ICEpdfDefault.properties file that can be used to load default viewer properties
* for custom builds. This mechanism can be easier to implement then manually manipulating the PropertyManagers before
* the a swing view is created.
*
*
* @since 6.3
*/
public final class ViewerPropertiesManager {
private static final Logger logger =
Logger.getLogger(ViewerPropertiesManager.class.toString());
// use ascii '27' or ESC as the delimiting character when storing multiple values in one property name.
public static final String PROPERTY_TOKEN_SEPARATOR = "|";
//default file for all not specified properties
public static final String DEFAULT_PROP_FILE = "ICEpdfDefault.properties";
public static final String DEFAULT_PROP_FILE_PATH = "org/icepdf/ri/viewer/res/";
public static final String DEFAULT_MESSAGE_BUNDLE = "org.icepdf.ri.resources.MessageBundle";
public static final String PROPERTY_DEFAULT_FILE_PATH = "application.default.filepath";
public static final String PROPERTY_DEFAULT_URL = "application.default.url";
public static final String PROPERTY_RECENT_FILES_SIZE = "application.menu.recent.file.size";
public static final String PROPERTY_ICON_DEFAULT_SIZE = "application.icon.default.size";
// window properties
public static final String PROPERTY_DIVIDER_LOCATION = "application.divider.location";
// default page fit mode
public static final String PROPERTY_DEFAULT_PAGEFIT = "document.pagefit.mode";
public static final String PROPERTY_DEFAULT_ROTATION = "document.rotation";
// page rotation
public static final String PROPERTY_DEFAULT_VIEW_TYPE = "document.viewtype";
// highlight and selection text colours.
public static final String PROPERTY_TEXT_SELECTION_COLOR = "org.icepdf.core.views.page.text.selection.color";
public static final String PROPERTY_TEXT_HIGHLIGHT_COLOR = "org.icepdf.core.views.page.text.highlight.color";
// page view colour settings.
public static final String PROPERTY_PAGE_VIEW_SHADOW_COLOR = "org.icepdf.core.views.page.shadow.color";
public static final String PROPERTY_PAGE_VIEW_PAPER_COLOR = "org.icepdf.core.views.page.paper.color";
public static final String PROPERTY_PAGE_VIEW_BORDER_COLOR = "org.icepdf.core.views.page.border.color";
public static final String PROPERTY_PAGE_VIEW_BACKGROUND_COLOR = "org.icepdf.core.views.background.color";
// image reference type.
public static final String PROPERTY_IMAGING_REFERENCE_TYPE = "org.icepdf.core.imageReference";
// advanced threading properties
public static final String PROPERTY_IMAGE_PROXY_ENABLED = "org.icepdf.core.imageProxy";
public static final String PROPERTY_IMAGE_PROXY_THREAD_COUNT = "org.icepdf.core.library.imageThreadPoolSize";
public static final String PROPERTY_COMMON_THREAD_COUNT = "org.icepdf.core.library.threadPoolSize";
// properties used to hide/show toolbars
public static final String PROPERTY_SHOW_MENU_RECENT_FILES = "application.toolbar.show.resentfiles";
public static final String PROPERTY_SHOW_TOOLBAR_UTILITY = "application.toolbar.show.utility";
public static final String PROPERTY_SHOW_TOOLBAR_PAGENAV = "application.toolbar.show.pagenav";
public static final String PROPERTY_SHOW_TOOLBAR_ZOOM = "application.toolbar.show.zoom";
public static final String PROPERTY_SHOW_TOOLBAR_FIT = "application.toolbar.show.fit";
public static final String PROPERTY_SHOW_TOOLBAR_FULL_SCREEN = "application.toolbar.show.fullscreen";
public static final String PROPERTY_SHOW_TOOLBAR_ROTATE = "application.toolbar.show.rotate";
public static final String PROPERTY_SHOW_TOOLBAR_TOOL = "application.toolbar.show.tool";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION = "application.toolbar.show.annotation";
public static final String PROPERTY_SHOW_TOOLBAR_FORMS = "application.toolbar.show.forms";
public static final String PROPERTY_SHOW_TOOLBAR_SEARCH = "application.toolbar.show.search";
// properties used to hide/show status bar buttons
public static final String PROPERTY_SHOW_STATUSBAR = "application.statusbar";
// properties used to hide/show status bar status label
public static final String PROPERTY_SHOW_STATUSBAR_STATUSLABEL = "application.statusbar.show.statuslabel";
// properties used to hide/show status bar buttons
public static final String PROPERTY_SHOW_STATUSBAR_VIEWMODE = "application.statusbar.show.viewmode";
public static final String PROPERTY_SHOW_STATUSBAR_VIEWMODE_SINGLE = "application.statusbar.show.viewmode.singlepage";
public static final String PROPERTY_SHOW_STATUSBAR_VIEWMODE_SINGLE_CONTINUOUS = "application.statusbar.show.viewmode.single.page.continuous";
public static final String PROPERTY_SHOW_STATUSBAR_VIEWMODE_DOUBLE = "application.statusbar.show.viewmode.double.page";
public static final String PROPERTY_SHOW_STATUSBAR_VIEWMODE_DOUBLE_CONTINUOUS = "application.statusbar.show.viewmode.double.page.continuous";
// properties used to hide/show the utility buttons (open, print, etc.)
public static final String PROPERTY_SHOW_UTILITY_OPEN = "application.toolbar.show.utility.open";
public static final String PROPERTY_SHOW_UTILITY_SAVE = "application.toolbar.show.utility.save";
public static final String PROPERTY_SHOW_UTILITY_PRINT = "application.toolbar.show.utility.print";
public static final String PROPERTY_SHOW_UTILITY_SEARCH = "application.toolbar.show.utility.search";
public static final String PROPERTY_SHOW_UTILITY_UPANE = "application.toolbar.show.utility.upane";
// properties used to hide/show utility pane tabs
public static final String PROPERTY_HIDE_UTILITYPANE = "application.utilitypane.hide";
public static final String PROPERTY_SHOW_UTILITYPANE_BOOKMARKS = "application.utilitypane.show.bookmarks";
public static final String PROPERTY_SHOW_UTILITYPANE_ATTACHMENTS = "application.utilitypane.show.attachments";
public static final String PROPERTY_SHOW_UTILITYPANE_SEARCH = "application.utilitypane.show.search";
public static final String PROPERTY_SHOW_UTILITYPANE_THUMBNAILS = "application.utilitypane.show.thumbs";
public static final String PROPERTY_SHOW_UTILITYPANE_LAYERS = "application.utilitypane.show.layers";
public static final String PROPERTY_SHOW_UTILITYPANE_ANNOTATION = "application.utilitypane.show.annotation";
public static final String PROPERTY_SHOW_UTILITYPANE_ANNOTATION_FLAGS = "application.utilitypane.show.annotation.flags";
public static final String PROPERTY_SHOW_UTILITYPANE_SIGNATURES = "application.utilitypane.show.signatures";
// sub control for annotation tabs
public static final String PROPERTY_SHOW_UTILITYPANE_ANNOTATION_MARKUP = "application.utilitypane.show.annotation.markup";
public static final String PROPERTY_SHOW_UTILITYPANE_ANNOTATION_DESTINATIONS = "application.utilitypane.show.annotation.dests";
// properties use dot hide/show preferences pane tabs.
public static final String PROPERTY_SHOW_PREFERENCES_GENERAL = "application.preferences.show.general";
public static final String PROPERTY_SHOW_PREFERENCES_ANNOTATIONS = "application.preferences.show.annotations";
public static final String PROPERTY_SHOW_PREFERENCES_IMAGING = "application.preferences.show.imaging";
public static final String PROPERTY_SHOW_PREFERENCES_FONTS = "application.preferences.show.fonts";
public static final String PROPERTY_SHOW_PREFERENCES_ADVANCED = "application.preferences.show.advanced";
public static final String PROPERTY_SHOW_PREFERENCES_EXIMPORT = "application.preferences.show.eximport";
// default utility pane thumbnail zoom size for non-embedded files
public static final String PROPERTY_UTILITYPANE_THUMBNAILS_ZOOM = "application.utilitypane.thumbnail.zoom";
// properties used for default zoom levels
public static final String PROPERTY_DEFAULT_ZOOM_LEVEL = "application.zoom.factor.default";
public static final String PROPERTY_ZOOM_RANGES = "application.zoom.range.default";
// property to hide/show menu keyboard accelerator shortcuts
public static final String PROPERTY_SHOW_KEYBOARD_SHORTCUTS = "application.menuitem.show.keyboard.shortcuts";
// properties used for overriding ViewerPreferences pulled from the document
public static final String PROPERTY_VIEWPREF_HIDETOOLBAR = "application.viewerpreferences.hidetoolbar";
public static final String PROPERTY_VIEWPREF_HIDEMENUBAR = "application.viewerpreferences.hidemenubar";
public static final String PROPERTY_VIEWPREF_FITWINDOW = "application.viewerpreferences.fitwindow";
public static final String PROPERTY_VIEWPREF_FORM_HIGHLIGHT = "application.viewerpreferences.form.highlight";
public static final String PROPERTY_VIEWPREF_ANNOTATION_EDIT_MODE = "application.viewerpreferences.annotation.editmode";
// annotation handler default to selected tool after annotation is created.
public static final String PROPERTY_ANNOTATION_HIGHLIGHT_SELECTION_TYPE = "application.annotation.highlight.selection.type";
public static final String PROPERTY_ANNOTATION_LINE_SELECTION_TYPE = "application.annotation.line.selection.type";
public static final String PROPERTY_ANNOTATION_LINK_SELECTION_TYPE = "application.annotation.link.selection.type";
public static final String PROPERTY_ANNOTATION_SQUARE_SELECTION_TYPE = "application.annotation.rectangle.selection.type";
public static final String PROPERTY_ANNOTATION_CIRCLE_SELECTION_TYPE = "application.annotation.circle.selection.type";
public static final String PROPERTY_ANNOTATION_INK_SELECTION_TYPE = "application.annotation.ink.selection.type";
public static final String PROPERTY_ANNOTATION_FREE_TEXT_SELECTION_TYPE = "application.annotation.freetext.selection.type";
public static final String PROPERTY_ANNOTATION_TEXT_SELECTION_TYPE = "application.annotation.text.selection.type";
public static final Set ALL_SELECTION_PROPERTIES = new HashSet<>(Arrays.asList(
ViewerPropertiesManager.PROPERTY_ANNOTATION_CIRCLE_SELECTION_TYPE,
ViewerPropertiesManager.PROPERTY_ANNOTATION_HIGHLIGHT_SELECTION_TYPE,
ViewerPropertiesManager.PROPERTY_ANNOTATION_INK_SELECTION_TYPE,
ViewerPropertiesManager.PROPERTY_ANNOTATION_LINE_SELECTION_TYPE,
ViewerPropertiesManager.PROPERTY_ANNOTATION_LINK_SELECTION_TYPE,
ViewerPropertiesManager.PROPERTY_ANNOTATION_SQUARE_SELECTION_TYPE,
ViewerPropertiesManager.PROPERTY_ANNOTATION_TEXT_SELECTION_TYPE,
ViewerPropertiesManager.PROPERTY_ANNOTATION_FREE_TEXT_SELECTION_TYPE
));
// properties used to control visibility of annotation controls on main utility panel.
public static final String PROPERTY_ANNOTATION_PROPERTIES_HIGHLIGHT_ENABLED = "application.annotation.properties.highlight.enabled";
public static final String PROPERTY_ANNOTATION_PROPERTIES_UNDERLINE_ENABLED = "application.annotation.properties.underline.enabled";
public static final String PROPERTY_ANNOTATION_PROPERTIES_STRIKE_OUT_ENABLED = "application.annotation.properties.strikeout.enabled";
public static final String PROPERTY_ANNOTATION_PROPERTIES_LINE_ENABLED = "application.annotation.properties.line.enabled";
public static final String PROPERTY_ANNOTATION_PROPERTIES_LINK_ENABLED = "application.annotation.properties.link.enabled";
public static final String PROPERTY_ANNOTATION_PROPERTIES_ARROW_ENABLED = "application.annotation.properties.arrow.enabled";
public static final String PROPERTY_ANNOTATION_PROPERTIES_RECTANGLE_ENABLED = "application.annotation.properties.rectangle.enabled";
public static final String PROPERTY_ANNOTATION_PROPERTIES_CIRCLE_ENABLED = "application.annotation.properties.circle.enabled";
public static final String PROPERTY_ANNOTATION_PROPERTIES_INK_ENABLED = "application.annotation.properties.ink.enabled";
public static final String PROPERTY_ANNOTATION_PROPERTIES_FREE_TEXT_ENABLED = "application.annotation.properties.freetext.enabled";
public static final String PROPERTY_ANNOTATION_PROPERTIES_TEXT_ENABLED = "application.annotation.properties.text.enabled";
public static final String PROPERTY_ANNOTATION_EDITING_MODE_ENABLED = "application.annotation.editing.mode.enabled";
// Individual controls for the annotation toolbar button commands
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_SELECTION = "application.toolbar.annotation.selection.enabled";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_HIGHLIGHT = "application.toolbar.annotation.highlight.enabled";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_UNDERLINE = "application.toolbar.annotation.underline.enabled";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_STRIKE_OUT = "application.toolbar.annotation.strikeout.enabled";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_LINE = "application.toolbar.annotation.line.enabled";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_LINK = "application.toolbar.annotation.link.enabled";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_ARROW = "application.toolbar.annotation.arrow.enabled";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_RECTANGLE = "application.toolbar.annotation.rectangle.enabled";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_CIRCLE = "application.toolbar.annotation.circle.enabled";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_INK = "application.toolbar.annotation.ink.enabled";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_FREE_TEXT = "application.toolbar.annotation.freetext.enabled";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_TEXT = "application.toolbar.annotation.text.enabled";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_PERMISSION = "application.toolbar.annotation.permission.enabled";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_UTILITY = "application.toolbar.annotation.toolbar.enabled";
public static final String PROPERTY_SHOW_TOOLBAR_BOOKMARK_UTILITY = "application.toolbar.bookmark.toolbar.enabled";
public static final String PROPERTY_SHOW_TOOLBAR_ANNOTATION_PREVIEW = "application.toolbar.annotation.preview.enabled";
// Individual control of the markup annotation context menu
public static final String PROPERTY_SHOW_ANNOTATION_MARKUP_REPLY_TO = "application.annotation.show.markup.replyTo";
public static final String PROPERTY_SHOW_ANNOTATION_MARKUP_ADD_ANNOTATIONS = "application.annotation.show.markup.addAnnotations";
public static final String PROPERTY_SHOW_ANNOTATION_MARKUP_SET_STATUS = "application.annotation.show.markup.setStatus";
// highlight annotation default colour as defined by the last used colour for each type.
public static final String PROPERTY_ANNOTATION_HIGHLIGHT_COLOR = "application.viewer.preference.annotation.highlight.color";
public static final String PROPERTY_ANNOTATION_HIGHLIGHT_OPACITY = "application.viewer.preference.annotation.highlight.opacity";
public static final String PROPERTY_ANNOTATION_STRIKE_OUT_COLOR = "application.viewer.preference.annotation.strikeout.color";
public static final String PROPERTY_ANNOTATION_STRIKE_OUT_OPACITY = "application.viewer.preference.annotation.strikeout.opacity";
public static final String PROPERTY_ANNOTATION_UNDERLINE_COLOR = "application.viewer.preference.annotation.underline.color";
public static final String PROPERTY_ANNOTATION_UNDERLINE_OPACITY = "application.viewer.preference.annotation.underline.opacity";
public static final String PROPERTY_ANNOTATION_SQUIGGLY_COLOR = "application.viewer.preference.annotation.squiggly.color";
public static final String PROPERTY_ANNOTATION_SQUIGGLY_OPACITY = "application.viewer.preference.annotation.squiggly.opacity";
public static final String PROPERTY_ANNOTATION_TEXT_COLOR = "application.viewer.preference.annotation.text.color";
public static final String PROPERTY_ANNOTATION_TEXT_OPACITY = "application.viewer.preference.annotation.text.opacity";
public static final String PROPERTY_ANNOTATION_TEXT_ICON = "application.viewer.preference.annotation.text.icon";
public static final String PROPERTY_ANNOTATION_INK_COLOR = "application.viewer.preference.annotation.ink.color";
public static final String PROPERTY_ANNOTATION_INK_OPACITY = "application.viewer.preference.annotation.ink.opacity";
// annotation types with stroke and fill colours
public static final String PROPERTY_ANNOTATION_SQUARE_COLOR = "application.viewer.preference.annotation.square.color";
public static final String PROPERTY_ANNOTATION_SQUARE_FILL_COLOR = "application.viewer.preference.annotation.square.fill.color";
public static final String PROPERTY_ANNOTATION_SQUARE_OPACITY = "application.viewer.preference.annotation.square.fill.opacity";
public static final String PROPERTY_ANNOTATION_CIRCLE_COLOR = "application.viewer.preference.annotation.circle.color";
public static final String PROPERTY_ANNOTATION_CIRCLE_FILL_COLOR = "application.viewer.preference.annotation.circle.fill.color";
public static final String PROPERTY_ANNOTATION_CIRCLE_OPACITY = "application.viewer.preference.annotation.circle.fill.opacity";
public static final String PROPERTY_ANNOTATION_LINE_COLOR = "application.viewer.preference.annotation.line.color";
public static final String PROPERTY_ANNOTATION_LINE_FILL_COLOR = "application.viewer.preference.annotation.line.fill.color";
public static final String PROPERTY_ANNOTATION_LINE_OPACITY = "application.viewer.preference.annotation.line.fill.opcity";
public static final String PROPERTY_ANNOTATION_LINE_ARROW_COLOR = "application.viewer.preference.annotation.arrow.color";
public static final String PROPERTY_ANNOTATION_LINE_ARROW_FILL_COLOR = "application.viewer.preference.annotation.arrow.fill.color";
public static final String PROPERTY_ANNOTATION_LINE_ARROW_OPACITY = "application.viewer.preference.annotation.arrow.fill.opacity";
// free text, quite a lot of properties
public static final String PROPERTY_ANNOTATION_FREE_TEXT_COLOR = "application.viewer.preference.annotation.freetext.color";
public static final String PROPERTY_ANNOTATION_FREE_TEXT_SIZE = "application.viewer.preference.annotation.freetext.size";
public static final String PROPERTY_ANNOTATION_FREE_TEXT_FONT = "application.viewer.preference.annotation.freetext.font";
public static final String PROPERTY_ANNOTATION_FREE_TEXT_OPACITY = "application.viewer.preference.annotation.freetext.opacity";
public static final String PROPERTY_ANNOTATION_FREE_TEXT_FILL_COLOR = "application.viewer.preference.annotation.freetext.fill.color";
public static final String PROPERTY_ANNOTATION_FREE_TEXT_BORDER_COLOR = "application.viewer.preference.annotation.freetext.border.color";
// we use the same recent colour list for all annotation types
public static final String PROPERTY_ANNOTATION_RECENT_COLORS = "application.viewer.preference.annotation.color.recent";
// resent colour and labels, enabled automatically if there is more then one.
public static final String PROPERTY_ANNOTATION_RECENT_COLOR_LABEL = "application.viewer.preference.annotation.recent.color.labels";
// store for recently opened files.
public static final String PROPERTY_RECENTLY_OPENED_FILES = "application.viewer.preference.recent.files";
// store of sort, filter and quick colour markup annotation utility pane persisted values.
public static final String PROPERTY_ANNOTATION_SORT_COLUMN = "application.viewer.utility.annotation.sort.column";
public static final String PROPERTY_ANNOTATION_FILTER_AUTHOR_COLUMN = "application.viewer.utility.annotation.filter.author.column";
public static final String PROPERTY_ANNOTATION_FILTER_VISIBILITY_COLUMN = "application.viewer.utility.annotation.filter.visibility.column";
public static final String PROPERTY_ANNOTATION_FILTER_TYPE_COLUMN = "application.viewer.utility.annotation.filter.type.column";
public static final String PROPERTY_ANNOTATION_FILTER_COLOR_COLUMN = "application.viewer.utility.annotation.filter.color.column";
public static final String PROPERTY_ANNOTATION_QUICK_COLOR = "application.viewer.utility.annotation.filter.quick.color";
// text search panel settings
public static final String PROPERTY_SEARCH_PANEL_WHOLE_PAGE_ENABLED = "application.viewer.utility.search.whole.page.enabled";
public static final String PROPERTY_SEARCH_PANEL_REGEX_ENABLED = "application.viewer.utility.search.regex.enabled";
public static final String PROPERTY_SEARCH_PANEL_WHOLE_WORDS_ENABLED = "application.viewer.utility.search.whole.words.enabled";
public static final String PROPERTY_SEARCH_PANEL_CASE_SENSITIVE_ENABLED = "application.viewer.utility.search.case.sensitive.enabled";
public static final String PROPERTY_SEARCH_PANEL_CUMULATIVE_ENABLED = "application.viewer.utility.search.case.cumulative.enabled";
public static final String PROPERTY_SEARCH_PANEL_SEARCH_COMMENTS_ENABLED = "application.viewer.utility.search.comments.cumulative.enabled";
public static final String PROPERTY_SEARCH_PANEL_SEARCH_DEST_ENABLED = "application.viewer.utility.search.case.destinations.enabled";
public static final String PROPERTY_SEARCH_PANEL_SEARCH_TEXT_ENABLED = "application.viewer.utility.search.case.text.enabled";
public static final String PROPERTY_SEARCH_PANEL_SEARCH_FORMS_ENABLED = "application.viewer.utility.search.case.forms.enabled";
public static final String PROPERTY_SEARCH_PANEL_SEARCH_OUTLINES_ENABLED = "application.viewer.utility.search.case.outlines.enabled";
public static final String PROPERTY_SEARCH_PANEL_SHOW_PAGES_ENABLED = "application.viewer.utility.search.case.pages.enabled";
public static final String PROPERTY_QUICK_SEARCH_WHOLE_WORDS_ENABLED = "application.viewer.toolbar.search.whole.words.enabled";
public static final String PROPERTY_QUICK_SEARCH_CASE_SENSITIVE_ENABLED = "application.viewer.toolbar.search.case.sensitive.enabled";
public static final String PROPERTY_QUICK_SEARCH_SEARCH_COMMENTS_ENABLED = "application.viewer.toolbar.search.comments.cumulative.enabled";
// markup search panel settings
public static final String PROPERTY_SEARCH_MARKUP_PANEL_REGEX_ENABLED = "application.viewer.utility.search.markup.regex.enabled";
public static final String PROPERTY_SEARCH_MARKUP_PANEL_CASE_SENSITIVE_ENABLED = "application.viewer.utility.search.markup.case.sensitive.enabled";
// annotation summary panel font size and name.
public static final String PROPERTY_ANNOTATION_SUMMARY_FONT_NAME = "application.viewer.annotation.summary.font.name";
public static final String PROPERTY_ANNOTATION_SUMMARY_FONT_SIZE = "application.viewer.annotation.summary.font.size";
// stored state of last used public/private annotation flag.
public static final String PROPERTY_ANNOTATION_LAST_USED_PUBLIC_FLAG = "application.viewer.annotation.public.flag";
private static ViewerPropertiesManager propertiesManager;
// static store of properties which are persisted to backing store.
private static Preferences preferences = Preferences.userNodeForPackage(ViewerPropertiesManager.class);
// local properties, that aren't persisted and can override properties in the store if root accessor are used.
private static Properties localProperties;
// default properties file included int the viewer jar
private static Properties defaultProps;
private ViewerPropertiesManager() {
}
/**
* Gets singleton instance of the the Properties manager instance.
*
* @return singleton instance.
*/
public static ViewerPropertiesManager getInstance() {
if (propertiesManager == null) {
propertiesManager = new ViewerPropertiesManager();
try {
if (preferences.keys().length == 0) {
// load default properties from viewer jar and assigned to defaultProps.
setupDefaultProperties();
saveLocalProperties();
} else {
updatePropertiesWithPreferences();
}
} catch (BackingStoreException e) {
logger.severe("Couldn't access backing store");
setupDefaultProperties();
}
}
return propertiesManager;
}
/**
* Prints all the preferences and properties. Can be used to see discrepancies.
*/
public static void printAllProperties() {
try {
Arrays.stream(preferences.keys()).forEach(key -> {
logger.fine(key + " -> " + preferences.get(key, ""));
logger.fine(key + " -> " + propertiesManager.checkAndStoreStringProperty(key, ""));
});
} catch (BackingStoreException e) {
e.printStackTrace();
}
}
private static void updatePropertiesWithPreferences() throws BackingStoreException {
defaultProps = new SortedProperties();
Arrays.stream(preferences.keys()).forEach(key -> {
defaultProps.setProperty(key, preferences.get(key, null));
});
localProperties = new SortedProperties(defaultProps);
}
/**
* Gets the Preferences backing store for persisting static properties and settings.
*
* @return reference to the application preferences backing store.
*/
public Preferences getPreferences() {
return preferences;
}
/**
* Sets the local property over writing any previous value stored in the default properties file.
*
* @param propertyName name of property to write.
* @param value property value.
*/
public void set(String propertyName, String value) {
localProperties.setProperty(propertyName, value);
preferences.put(propertyName, value);
}
/**
* Removes the
*
* @param propertyName
*/
public void remove(String propertyName) {
localProperties.remove(propertyName);
}
/**
* All of the properties that are stored in the local properties can be persisted to the backing store via this
* method call. The local properties are stored via the checkAndStore*() method calls and should only be used
* when configuring the viewer components functionality. Once these properties have been persisted they are
* now sticky and will persist for all viewer instances.
*/
public static void saveLocalProperties() {
Enumeration keys = localProperties.keys();
while (keys.hasMoreElements()) {
String key = (String) keys.nextElement();
preferences.put(key, localProperties.getProperty(key));
}
}
/**
* Sets the local double property over writing any previous value stored in the default properties file.
*
* @param propertyName name of property to write.
* @param value property value.
*/
public void setDouble(String propertyName, double value) {
localProperties.setProperty(propertyName, Double.toString(value));
preferences.putDouble(propertyName, value);
}
/**
* Sets the local float property over writing any previous value stored in the default properties file.
*
* @param propertyName name of property to write.
* @param value property value.
*/
public void setFloat(String propertyName, float value) {
localProperties.setProperty(propertyName, Float.toString(value));
preferences.putFloat(propertyName, value);
}
/**
* Sets the local integer property over writing any previous value stored in the default properties file.
*
* @param propertyName name of property to write.
* @param value property value.
*/
public void setInt(String propertyName, int value) {
localProperties.setProperty(propertyName, Integer.toString(value));
preferences.putInt(propertyName, value);
}
/**
* Sets the local boolean property over writing any previous value stored in the default properties file.
*
* @param propertyName name of property to write.
* @param value property value.
*/
public void setBoolean(String propertyName, boolean value) {
localProperties.setProperty(propertyName, Boolean.toString(value));
preferences.putBoolean(propertyName, value);
}
/**
* Method to check the value of a string property
* This is meant to be used for configuration via the properties file
* After the property has been checked, it will be stored back into the Properties
* object (using a default value if none was found)
*
* @param propertyName to check for
* @param defaultVal to default to if no value is found on a property
* @return String value for the propertyName or defaultVal if none exists.
*/
public String checkAndStoreStringProperty(String propertyName, String defaultVal) {
// Get the desired property, defaulting to the defaultVal parameter
String returnValue = localProperties.getProperty(propertyName, defaultVal);
// Set the property back into the manager
// This is necessary in the cases where a property didn't exist, but needs to be added to the file
localProperties.setProperty(propertyName, returnValue);
return returnValue;
}
public boolean checkAndStoreBooleanProperty(String propertyName) {
return checkAndStoreBooleanProperty(propertyName, true);
}
/**
* Method to check the value of a boolean property
* This is meant to be used for configuration via the properties file
* After the property has been checked, it will be stored back into the Properties
* object (using a default value if none was found)
*
* @param propertyName to check for
* @param defaultVal to default to if no value is found on a property
* @return true if property is true, otherwise false
*/
public boolean checkAndStoreBooleanProperty(String propertyName, boolean defaultVal) {
// Get the desired property, defaulting to the defaultVal parameter
boolean returnValue = Boolean.parseBoolean(
localProperties.getProperty(propertyName, Boolean.toString(defaultVal)));
// Set the property back into the manager
// This is necessary in the cases where a property didn't exist, but needs to be added to the file
localProperties.setProperty(propertyName, String.valueOf(returnValue));
return returnValue;
}
public double checkAndStoreDoubleProperty(String propertyName) {
return checkAndStoreDoubleProperty(propertyName, 1.0f);
}
/**
* Method to check the value of a double property
* This is meant to be used for configuration via the properties file
* After the property has been checked, it will be stored back into the Properties
* object (using a default value if none was found)
*
* @param propertyName to check for
* @param defaultVal to default to if no value is found on a property
* @return double property value
*/
public double checkAndStoreDoubleProperty(String propertyName, double defaultVal) {
// Get the desired property, defaulting to the defaultVal parameter
double returnValue = Double.parseDouble(localProperties.getProperty(propertyName, Double.toString(defaultVal)));
// Set the property back into the manager
// This is necessary in the cases where a property didn't exist, but needs to be added to the file
localProperties.setProperty(propertyName, String.valueOf(returnValue));
return returnValue;
}
public int checkAndStoreIntProperty(String propertyName) {
return checkAndStoreIntProperty(propertyName, 1);
}
/**
* Method to check the value of an int property
* This is meant to be used for configuration via the properties file
* After the property has been checked, it will be stored back into the Properties
* object (using a default value if none was found)
*
* @param propertyName to check for
* @param defaultVal to default to if no value is found on a property
* @return int value of property
*/
public int checkAndStoreIntProperty(String propertyName, int defaultVal) {
// Get the desired property, defaulting to the defaultVal parameter
int returnValue = Integer.parseInt(localProperties.getProperty(propertyName, Integer.toString(defaultVal)));
// Set the property back into the manager
// This is necessary in the cases where a property didn't exist, but needs to be added to the file
localProperties.setProperty(propertyName, String.valueOf(returnValue));
return returnValue;
}
public float checkAndStoreFloatProperty(String propertyName) {
return checkAndStoreFloatProperty(propertyName, 1);
}
/**
* Method to check the value of an int property
* This is meant to be used for configuration via the properties file
* After the property has been checked, it will be stored back into the Properties
* object (using a default value if none was found)
*
* @param propertyName to check for
* @param defaultVal to default to if no value is found on a property
* @return int value of property
*/
public float checkAndStoreFloatProperty(String propertyName, float defaultVal) {
// Get the desired property, defaulting to the defaultVal parameter
float returnValue = Float.parseFloat(localProperties.getProperty(propertyName, Float.toString(defaultVal)));
// Set the property back into the manager
// This is necessary in the cases where a property didn't exist, but needs to be added to the file
localProperties.setProperty(propertyName, String.valueOf(returnValue));
return returnValue;
}
/**
* Method to check the value of a comma separate list of floats property
* For example we will convert "0.4f, 0.5f, 0.6f" to a size 3 array with the values as floats
* This is meant to be used for configuration via the properties file
* After the property has been checked, it will be stored back into the Properties
* object (using a default value if none was found)
*
* @param propertyName to check for
* @param defaultVal to default to if no value is found on a property
* @return array of floats from the property
*/
public float[] checkAndStoreFloatArrayProperty(String propertyName, float[] defaultVal) {
// Get the desired property, defaulting to the defaultVal parameter
String propertyString = localProperties.getProperty(propertyName);
float[] toReturn = defaultVal;
try {
// Ensure we have a property string to parse
// Then we'll convert the comma separated property to a list of floats
if ((propertyString != null) &&
(propertyString.trim().length() > 0)) {
String[] split = propertyString.split(",");
toReturn = new float[split.length];
for (int i = 0; i < split.length; i++) {
try {
toReturn[i] = Float.parseFloat(split[i]);
} catch (NumberFormatException failedValue) {
/* ignore as we'll just automatically put a '0' in the invalid space */
}
}
}
// Otherwise convert the defaultVal into a comma separated list
// This is done so it can be stored back into the properties file
else {
StringBuilder commaBuffer = new StringBuilder(defaultVal.length * 2);
for (int i = 0; i < defaultVal.length; i++) {
commaBuffer.append(defaultVal[i]);
// Check whether we need a comma
if ((i + 1) < defaultVal.length) {
commaBuffer.append(",");
}
}
// Set the property back into the manager
// This is necessary in the cases where a property didn't exist, but needs to be added to the file
localProperties.setProperty(propertyName, commaBuffer.toString());
}
} catch (Exception failedProperty) {
/* ignore on failure as we'll just return defaultVal */
}
return toReturn;
}
/**
* Allows users to set the default look and feel of the
*
* @param propertyName look and feel class and package name.
* @param defaultValue default value
* @param messageBundle message bundle.
* @return class name used to set the look and feel
*/
public String getLookAndFeel(String propertyName, String defaultValue, ResourceBundle messageBundle) {
String value = preferences.get(propertyName, null);
if (value != null) {
String result = Parse.parseLookAndFeel(value, messageBundle);
if (result != null) {
return result;
}
preferences.remove(propertyName);
}
if (defaultProps != null) {
value = defaultProps.getProperty(propertyName);
if (value != null) {
String result = Parse.parseLookAndFeel(value, null);
if (result != null) {
return result;
}
preferences.remove(propertyName);
Resources.showMessageDialog(null,
JOptionPane.ERROR_MESSAGE, messageBundle,
"manager.properties.title",
"manager.properties.lafError", value);
}
}
return defaultValue;
}
/**
* This utility method removes all entries in the preferences backing store. This method does not remove the
* preferences node and thus the font manager font cache is unaffected.
*/
public void clearPreferences() {
try {
String[] keys = preferences.keys();
for (String key : keys) {
preferences.remove(key);
}
} catch (Throwable ex) {
// log the error
if (logger.isLoggable(Level.WARNING)) {
logger.log(Level.WARNING, "Error clearing preferences cache", ex);
}
}
}
/**
* Reads the properties file that ships with the viewer jar and stores the default properties in the preferences
* backing store. This is only done on first launch.
*/
private static void setupDefaultProperties() {
// load the default values every time into our local store.
try (InputStream in = getResourceAsStream(DEFAULT_PROP_FILE_PATH, DEFAULT_PROP_FILE)) {
defaultProps = new SortedProperties();
if (in != null) {
defaultProps.load(in);
// we only set the default preferences on first load.
if (preferences.get(PROPERTY_DEFAULT_FILE_PATH, null) == null) {
Enumeration keys = defaultProps.keys();
while (keys.hasMoreElements()) {
String key = (String) keys.nextElement();
preferences.put(key, defaultProps.getProperty(key));
}
}
} else if (logger.isLoggable(Level.FINER)) {
logger.finer("Default properties file could not be found on the class path. ");
}
} catch (Throwable ex) {
// log the error
if (logger.isLoggable(Level.WARNING)) {
logger.log(Level.WARNING, "Error loading default properties cache", ex);
}
}
// copy over the default properties.
localProperties = new SortedProperties(defaultProps);
}
public static boolean importPreferences(File xml) {
try (InputStream in = new BufferedInputStream(new FileInputStream(xml))) {
Preferences.importPreferences(in);
preferences = Preferences.userNodeForPackage(ViewerPropertiesManager.class);
updatePropertiesWithPreferences();
return true;
} catch (IOException | InvalidPreferencesFormatException | BackingStoreException e) {
logger.warning("Couldn't load file " + xml.getAbsolutePath());
return false;
}
}
public static boolean exportPreferences(File xml) {
try (OutputStream out = new BufferedOutputStream(new FileOutputStream(xml))) {
preferences.exportSubtree(out);
return true;
} catch (BackingStoreException | IOException e) {
logger.warning("Couldn't write to file " + xml.getAbsolutePath());
return false;
}
}
public static boolean importProperties(File file) {
try (InputStream in = new BufferedInputStream(new FileInputStream(file))) {
localProperties.load(in);
saveLocalProperties();
return true;
} catch (IOException e) {
logger.warning("Couldn't load file " + file.getAbsolutePath());
return false;
}
}
public static boolean exportProperties(File file) {
try (OutputStream out = new BufferedOutputStream(new FileOutputStream(file))) {
localProperties.store(out, "IcePDF properties file");
return true;
} catch (IOException e) {
logger.warning("Couldn't write to file " + file.getAbsolutePath());
return false;
}
}
private static InputStream getResourceAsStream(String prefix, String resourcePath) {
int colon = resourcePath.indexOf(':');
if (colon >= 0) {
if (resourcePath.lastIndexOf(colon - 1, '/') < 0) {
try {
return (new URL(resourcePath)).openStream();
} catch (IOException e) {
// eat the exception
}
return null;
}
}
resourcePath = makeResPath(prefix, resourcePath);
ClassLoader cl = prefix.getClass().getClassLoader();
if (cl != null) {
InputStream result = cl.getResourceAsStream(resourcePath);
if (result != null) {
return result;
}
}
return ClassLoader.getSystemResourceAsStream(resourcePath);
}
private static String makeResPath(String prefix, String base_name) {
if (base_name.length() != 0 && base_name.charAt(0) == '/') {
return base_name.substring(1, base_name.length());
} else if (prefix == null) {
return base_name;
} else {
return prefix + base_name;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy