public class JabRefPreferences
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
AUTOCOMPLETE_FIRSTNAME_MODE |
static java.lang.String |
AUTOCOMPLETE_FIRSTNAME_MODE_BOTH |
static java.lang.String |
AUTOCOMPLETE_FIRSTNAME_MODE_ONLY_ABBR |
static java.lang.String |
AUTOCOMPLETE_FIRSTNAME_MODE_ONLY_FULL |
static java.lang.String |
CUSTOM_TAB_FIELDS |
static java.lang.String |
CUSTOM_TAB_NAME |
static java.lang.String |
CUSTOM_TYPE_NAME |
static java.lang.String |
CUSTOM_TYPE_OPT |
static java.lang.String |
CUSTOM_TYPE_PRIOPT |
static java.lang.String |
CUSTOM_TYPE_REQ |
java.util.HashMap<java.lang.String,java.lang.String> |
customExportNameFormatters |
CustomExportList |
customExports |
CustomImportList |
customImports
Set with all custom
ImportFormat s |
java.io.File |
databaseFile |
static java.lang.String |
DEFAULT_REG_EXP_SEARCH_EXPRESSION_KEY |
java.util.HashMap<java.lang.String,java.lang.Object> |
defaults |
java.util.HashMap<java.lang.String,java.lang.String> |
defKeyBinds |
static java.lang.String |
EDIT_GROUP_MEMBERSHIP_MODE |
static java.lang.String |
EMACS_23 |
static java.lang.String |
EMACS_ADDITIONAL_PARAMETERS |
static java.lang.String |
EMACS_PATH |
static java.lang.String |
EMAIL_SUBJECT |
static java.lang.String |
FILE_TYPE_REMOVED_FLAG |
java.lang.String[] |
fileDirForDatabase |
ExternalFileType |
HTML_FALLBACK_TYPE |
java.util.HashMap<java.lang.String,java.lang.String> |
keyBinds |
java.lang.String |
MARKING_WITH_NUMBER_PATTERN |
static java.lang.String |
OPEN_FOLDERS_OF_ATTACHED_FILES |
static java.lang.String |
PDF_PREVIEW |
static java.lang.String |
REG_EXP_SEARCH_EXPRESSION_KEY |
static java.lang.String |
SHORTEST_TO_COMPLETE |
static java.lang.String |
SHOWONELETTERHEADINGFORICONCOLUMNS |
static java.lang.String |
USE_REG_EXP_SEARCH_KEY |
java.lang.String |
WRAPPED_USERNAME |
Modifier and Type | Method and Description |
---|---|
void |
clear()
Clear all preferences.
|
void |
clear(java.lang.String key) |
void |
exportPreferences(java.lang.String filename)
Exports Preferences to an XML file.
|
void |
flush()
Calling this method will write all preferences into the preference store.
|
java.lang.String |
get(java.lang.String key) |
java.lang.String |
get(java.lang.String key,
java.lang.String def) |
boolean |
getBoolean(java.lang.String key) |
boolean |
getBooleanDefault(java.lang.String key) |
byte[] |
getByteArray(java.lang.String key) |
byte[] |
getByteArrayDefault(java.lang.String key) |
java.awt.Color |
getColor(java.lang.String key)
Looks up a color definition in preferences, and returns the Color object.
|
CustomEntryType |
getCustomEntryType(int number)
Retrieves all information about the entry type in preferences,
with the tag given by number.
|
java.awt.Color |
getDefaultColor(java.lang.String key) |
java.util.List<ExternalFileType> |
getDefaultExternalFileTypes() |
java.util.HashMap<java.lang.String,java.lang.String> |
getDefaultKeys()
Returns the HashMap containing default key bindings.
|
double |
getDouble(java.lang.String key) |
double |
getDoubleDefault(java.lang.String key) |
EntryEditorTabList |
getEntryEditorTabList() |
ExternalFileType |
getExternalFileTypeByExt(java.lang.String extension)
Look up the external file type registered for this extension, if any.
|
ExternalFileType |
getExternalFileTypeByMimeType(java.lang.String mimeType)
Look up the external file type registered for this MIME type, if any.
|
ExternalFileType |
getExternalFileTypeByName(java.lang.String name)
Look up the external file type registered with this name, if any.
|
ExternalFileType |
getExternalFileTypeForName(java.lang.String filename)
Look up the external file type registered for this filename, if any.
|
ExternalFileType[] |
getExternalFileTypeSelection() |
static JabRefPreferences |
getInstance() |
int |
getInt(java.lang.String key) |
int |
getIntDefault(java.lang.String key) |
javax.swing.KeyStroke |
getKey(java.lang.String bindName)
Returns the KeyStroke for this binding, as defined by the
defaults, or in the Preferences.
|
java.util.HashMap<java.lang.String,java.lang.String> |
getKeyBindings()
Returns the HashMap containing all key bindings.
|
LabelPattern |
getKeyPattern()
Fetches key patterns from preferences
Not cached
|
int[] |
getRgb(java.lang.String value)
Looks up a color definition in preferences, and returns an array containing the RGB values.
|
java.lang.String[] |
getStringArray(java.lang.String key)
Returns a String[] containing the chosen columns.
|
boolean |
hasKey(java.lang.String key)
Check whether a key is set (differently from null).
|
void |
importPreferences(java.lang.String filename)
Imports Preferences from an XML file.
|
boolean |
isNonWrappableField(java.lang.String fieldName)
Determines whether the given field should be written without any sort of wrapping.
|
void |
purgeCustomEntryTypes(int number)
Removes all information about custom entry types with tags of
|
void |
purgeSeries(java.lang.String prefix,
int number)
Removes all entries keyed by prefix+number, where number
is equal to or higher than the given number.
|
void |
put(java.lang.String key,
java.lang.String value) |
void |
putBoolean(java.lang.String key,
boolean value) |
boolean |
putBracesAroundCapitals(java.lang.String fieldName) |
void |
putByteArray(java.lang.String key,
byte[] value) |
void |
putColor(java.lang.String key,
java.awt.Color color)
Stores a color in preferences.
|
void |
putDefaultValue(java.lang.String key,
java.lang.Object value)
Set the default value for a key.
|
void |
putDouble(java.lang.String key,
double value) |
void |
putInt(java.lang.String key,
int value) |
void |
putKeyPattern(LabelPattern pattern)
Adds the given key pattern to the preferences
|
void |
putStringArray(java.lang.String key,
java.lang.String[] value)
Puts a string array into the Preferences, by linking its elements
with ';' into a single string.
|
void |
remove(java.lang.String key) |
void |
setExternalFileTypes(java.util.List<ExternalFileType> types)
Reset the List of external file types after user customization.
|
void |
setLanguageDependentDefaultValues() |
void |
setNewKeyBindings(java.util.HashMap<java.lang.String,java.lang.String> newBindings)
Stores new key bindings into Preferences, provided they
actually differ from the old ones.
|
void |
storeCustomEntryType(CustomEntryType tp,
int number)
Stores all information about the entry type in preferences, with
the tag given by number.
|
void |
updateEntryEditorTabList() |
void |
updateExternalFileTypes()
Set up the list of external file types, either from default values, or from values
recorded in Preferences.
|
void |
updateSpecialFieldHandling() |
public static final java.lang.String CUSTOM_TYPE_NAME
public static final java.lang.String CUSTOM_TYPE_REQ
public static final java.lang.String CUSTOM_TYPE_OPT
public static final java.lang.String CUSTOM_TYPE_PRIOPT
public static final java.lang.String CUSTOM_TAB_NAME
public static final java.lang.String CUSTOM_TAB_FIELDS
public static final java.lang.String EMACS_PATH
public static final java.lang.String EMACS_ADDITIONAL_PARAMETERS
public static final java.lang.String EMACS_23
public static final java.lang.String EDIT_GROUP_MEMBERSHIP_MODE
public static final java.lang.String PDF_PREVIEW
public static final java.lang.String SHOWONELETTERHEADINGFORICONCOLUMNS
public static final java.lang.String SHORTEST_TO_COMPLETE
public static final java.lang.String AUTOCOMPLETE_FIRSTNAME_MODE
public static final java.lang.String AUTOCOMPLETE_FIRSTNAME_MODE_BOTH
public static final java.lang.String AUTOCOMPLETE_FIRSTNAME_MODE_ONLY_FULL
public static final java.lang.String AUTOCOMPLETE_FIRSTNAME_MODE_ONLY_ABBR
public static final java.lang.String FILE_TYPE_REMOVED_FLAG
public java.lang.String WRAPPED_USERNAME
public java.lang.String MARKING_WITH_NUMBER_PATTERN
public java.util.HashMap<java.lang.String,java.lang.Object> defaults
public java.util.HashMap<java.lang.String,java.lang.String> keyBinds
public java.util.HashMap<java.lang.String,java.lang.String> defKeyBinds
public CustomExportList customExports
public CustomImportList customImports
ImportFormat
spublic final ExternalFileType HTML_FALLBACK_TYPE
public java.lang.String[] fileDirForDatabase
public java.io.File databaseFile
public java.util.HashMap<java.lang.String,java.lang.String> customExportNameFormatters
public static final java.lang.String DEFAULT_REG_EXP_SEARCH_EXPRESSION_KEY
public static final java.lang.String REG_EXP_SEARCH_EXPRESSION_KEY
public static final java.lang.String USE_REG_EXP_SEARCH_KEY
public static final java.lang.String EMAIL_SUBJECT
public static final java.lang.String OPEN_FOLDERS_OF_ATTACHED_FILES
public static JabRefPreferences getInstance()
public void setLanguageDependentDefaultValues()
public boolean putBracesAroundCapitals(java.lang.String fieldName)
public void updateSpecialFieldHandling()
public boolean hasKey(java.lang.String key)
key
- The key to check.public java.lang.String get(java.lang.String key)
public java.lang.String get(java.lang.String key, java.lang.String def)
public boolean getBoolean(java.lang.String key)
public boolean getBooleanDefault(java.lang.String key)
public double getDouble(java.lang.String key)
public double getDoubleDefault(java.lang.String key)
public int getInt(java.lang.String key)
public int getIntDefault(java.lang.String key)
public byte[] getByteArray(java.lang.String key)
public byte[] getByteArrayDefault(java.lang.String key)
public void put(java.lang.String key, java.lang.String value)
public void putBoolean(java.lang.String key, boolean value)
public void putDouble(java.lang.String key, double value)
public void putInt(java.lang.String key, int value)
public void putByteArray(java.lang.String key, byte[] value)
public void remove(java.lang.String key)
public void putStringArray(java.lang.String key, java.lang.String[] value)
public java.lang.String[] getStringArray(java.lang.String key)
public java.awt.Color getColor(java.lang.String key)
key
- The key for this setting.public java.awt.Color getDefaultColor(java.lang.String key)
public void putDefaultValue(java.lang.String key, java.lang.Object value)
key
- The preferences key.value
- The default value.public void putColor(java.lang.String key, java.awt.Color color)
key
- The key for this setting.color
- The Color to store.public int[] getRgb(java.lang.String value)
value
- The key for this setting.public javax.swing.KeyStroke getKey(java.lang.String bindName)
public java.util.HashMap<java.lang.String,java.lang.String> getKeyBindings()
public java.util.HashMap<java.lang.String,java.lang.String> getDefaultKeys()
public void clear() throws java.util.prefs.BackingStoreException
java.util.prefs.BackingStoreException
public void clear(java.lang.String key) throws java.util.prefs.BackingStoreException
java.util.prefs.BackingStoreException
public void flush()
public void setNewKeyBindings(java.util.HashMap<java.lang.String,java.lang.String> newBindings)
public LabelPattern getKeyPattern()
public void putKeyPattern(LabelPattern pattern)
pattern
- the pattern to storepublic void storeCustomEntryType(CustomEntryType tp, int number)
public CustomEntryType getCustomEntryType(int number)
public java.util.List<ExternalFileType> getDefaultExternalFileTypes()
public ExternalFileType[] getExternalFileTypeSelection()
public ExternalFileType getExternalFileTypeByName(java.lang.String name)
name
- The file type name.public ExternalFileType getExternalFileTypeByExt(java.lang.String extension)
extension
- The file extension.public ExternalFileType getExternalFileTypeForName(java.lang.String filename)
filename
- The name of the file whose type to look up.public ExternalFileType getExternalFileTypeByMimeType(java.lang.String mimeType)
mimeType
- The MIME type.public void setExternalFileTypes(java.util.List<ExternalFileType> types)
types
- The new List of external file types. This is the complete list, not
just new entries.public void updateExternalFileTypes()
public void purgeCustomEntryTypes(int number)
number
- or higher.public void purgeSeries(java.lang.String prefix, int number)
number
- or higher.public EntryEditorTabList getEntryEditorTabList()
public void updateEntryEditorTabList()
public void exportPreferences(java.lang.String filename) throws java.io.IOException
filename
- String File to export tojava.io.IOException
public void importPreferences(java.lang.String filename) throws java.io.IOException
filename
- String File to import fromjava.io.IOException
public boolean isNonWrappableField(java.lang.String fieldName)
fieldName
- The field name.