| org.eclipse.jface.dialogs.IDialogSettings
All known Subclasses: org.eclipse.jface.dialogs.DialogSettings,
IDialogSettings | public interface IDialogSettings (Code) | | An interface to a storage mechanism for making dialog settings persistent.
The store manages a collection of key/value pairs. The keys must be strings
and the values can be either, strings or array of strings. Convenience API to
convert primitive types to strings is provided.
|
addNewSection | public IDialogSettings addNewSection(String name)(Code) | | Create a new section in the receiver and return it.
Parameters: name - the name of the new section the new section |
addSection | public void addSection(IDialogSettings section)(Code) | | Add a section in the receiver.
Parameters: section - the section to be added |
get | public String get(String key)(Code) | | Returns the value of the given key in this dialog settings.
Parameters: key - the key the value, or null if none |
getArray | public String[] getArray(String key)(Code) | | Returns the value, an array of strings, of the given key in this dialog
settings.
Parameters: key - the key the array of string, or null if none |
getBoolean | public boolean getBoolean(String key)(Code) | | Convenience API. Convert the value of the given key in this dialog
settings to a boolean and return it.
Parameters: key - the key the boolean value, or false if none |
getName | public String getName()(Code) | | Returns the IDialogSettings name.
the name |
getSection | public IDialogSettings getSection(String sectionName)(Code) | | Returns the section with the given name in this dialog settings.
Parameters: sectionName - the key IDialogSettings (the section), or null if none |
getSections | public IDialogSettings[] getSections()(Code) | | Returns all the sections in this dialog settings.
the section, or null if none |
load | public void load(Reader reader) throws IOException(Code) | | Load a dialog settings from a stream and fill the receiver with its
content.
Parameters: reader - a Reader specifying the stream where the settings are readfrom. throws: IOException - |
load | public void load(String fileName) throws IOException(Code) | | Load a dialog settings from a file and fill the receiver with its
content.
Parameters: fileName - the name of the file the settings are read from. throws: IOException - |
put | public void put(String key, String[] value)(Code) | | Adds the pair key/value to this dialog settings.
Parameters: key - the key. Parameters: value - the value to be associated with the key |
put | public void put(String key, double value)(Code) | | Convenience API. Converts the double value to a string and
adds the pair key/value to this dialog settings.
Parameters: key - the key. Parameters: value - the value to be associated with the key |
put | public void put(String key, float value)(Code) | | Convenience API. Converts the float value to a string and
adds the pair key/value to this dialog settings.
Parameters: key - the key. Parameters: value - the value to be associated with the key |
put | public void put(String key, int value)(Code) | | Convenience API. Converts the int value to a string and
adds the pair key/value to this dialog settings.
Parameters: key - the key. Parameters: value - the value to be associated with the key |
put | public void put(String key, long value)(Code) | | Convenience API. Converts the long value to a string and
adds the pair key/value to this dialog settings.
Parameters: key - the key. Parameters: value - the value to be associated with the key |
put | public void put(String key, String value)(Code) | | Adds the pair key/value to this dialog settings.
Parameters: key - the key. Parameters: value - the value to be associated with the key |
put | public void put(String key, boolean value)(Code) | | Convenience API. Converts the boolean value to a string
and adds the pair key/value to this dialog settings.
Parameters: key - the key. Parameters: value - the value to be associated with the key |
save | public void save(Writer writer) throws IOException(Code) | | Save a dialog settings to a stream
Parameters: writer - a Writer specifying the stream the settings are written in. throws: IOException - |
save | public void save(String fileName) throws IOException(Code) | | Save a dialog settings to a file.
Parameters: fileName - the name of the file the settings are written in. throws: IOException - |
|
|