|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Preferences
Singleton to provide preferences.
Preferences are currently stored in an XML file. Owner names and preference names must meet the following restrictions:
The first character must be a letter (not digit). Future characters must be letters, digits, _ or -; no spaces or other special characters.
To ensure uniqueness, if you create a new category of PreferencesOwner,
begin the string with a word and an underline;
Plugin_com.leafdigital.whatever
is how the system plugin
ones are generated.
Method Summary | |
---|---|
java.lang.String |
fromBoolean(boolean value)
|
java.lang.String |
fromFont(java.awt.Font value)
|
java.lang.String |
fromInt(int value)
|
PreferencesGroup |
getGroup(Plugin p)
Returns a preference group. |
PreferencesGroup |
getGroup(java.lang.String owner)
Returns a preference group. |
java.lang.String |
getPluginOwner(Plugin p)
|
java.lang.String |
getPluginOwner(java.lang.String className)
|
java.lang.String |
getSafeToken(java.lang.String name)
Given an arbitrary string, returns a token safe to use in preferences names. |
boolean |
toBoolean(java.lang.String value)
|
java.awt.Font |
toFont(java.lang.String value)
|
int |
toInt(java.lang.String value)
|
Method Detail |
---|
PreferencesGroup getGroup(java.lang.String owner)
owner
- Owner of preference (if in doubt, use getPluginOwner)
BugException
- If owner name is invalidPreferencesGroup getGroup(Plugin p)
p
- Plugin owning preference
int toInt(java.lang.String value) throws BugException
value
- Retrieved preference
BugException
- If conversion failsjava.lang.String fromInt(int value)
value
- Integer
java.awt.Font toFont(java.lang.String value) throws BugException
value
- Retrieved preference
BugException
- If conversion failsjava.lang.String fromFont(java.awt.Font value)
value
- Font to represent as string
boolean toBoolean(java.lang.String value) throws BugException
value
- Retrieved preference
BugException
- If conversion failsjava.lang.String fromBoolean(boolean value)
value
- Boolean to represent as string
java.lang.String getSafeToken(java.lang.String name)
name
- String
java.lang.String getPluginOwner(Plugin p)
p
- Plugin
java.lang.String getPluginOwner(java.lang.String className)
className
- Plugin class name
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |