Eclipse Plug-in Developer Guide (Galileo) - DialogSettings (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.dialogs
Class DialogSettings


java.lang.Object
  
org.eclipse.jface.dialogs.DialogSettings

All Implemented Interfaces:: IDialogSettings

public class DialogSettings
extends Object
implements IDialogSettings
extends Object
implements IDialogSettings

Concrete implementation of a dialog settings (IDialogSettings) using a hash table and XML. The dialog store can be read from and saved to a stream. All keys and values must be strings or array of strings. Primitive types are converted to strings.

This class was not designed to be subclassed. Here is an example of using a DialogSettings:

 
 DialogSettings settings = new DialogSettings("root");
 settings.put("Boolean1",true);
 settings.put("Long1",100);
 settings.put("Array1",new String[]{"aaaa1","bbbb1","cccc1"});
 DialogSettings section = new DialogSettings("sectionName");
 settings.addSection(section);
 section.put("Int2",200);
 section.put("Float2",1.1);
 section.put("Array2",new String[]{"aaaa2","bbbb2","cccc2"});
 settings.save("c:\\temp\\test\\dialog.xml");

Restriction:: This class is not intended to be subclassed by clients.

Constructor Summary

DialogSettings ( String sectionName)
          Create an empty dialog settings which loads and saves its content to a file.

Method Summary

IDialogSettings addNewSection ( String sectionName)
          Create a new section in the receiver and return it.

void addSection ( IDialogSettings section)
          Add a section in the receiver.

String get ( String key)
          Returns the value of the given key in this dialog settings.

String[] getArray ( String key)
          Returns the value, an array of strings, of the given key in this dialog settings.

boolean getBoolean ( String key)
          Convenience API.

double getDouble ( String key)
          Convenience API.

float getFloat ( String key)
          Convenience API.

int getInt ( String key)
          Convenience API.

long getLong ( String key)
          Convenience API.

String getName ()
          Returns the IDialogSettings name.

IDialogSettings getSection ( String sectionName)
          Returns the section with the given name in this dialog settings.

IDialogSettings[] getSections ()
          Returns all the sections in this dialog settings.

void load ( Reader r)
          Load a dialog settings from a stream and fill the receiver with its content.

void load ( String fileName)
          Load a dialog settings from a file and fill the receiver with its content.

void put ( String key, boolean value)
          Convenience API.

void put ( String key, double value)
          Convenience API.

void put ( String key, float value)
          Convenience API.

void put ( String key, int value)
          Convenience API.

void put ( String key, long value)
          Convenience API.

void put ( String key, String value)
          Adds the pair key/value to this dialog settings.

void put ( String key, String[] value)
          Adds the pair key/value to this dialog settings.

void save ( String fileName)
          Save a dialog settings to a file.

void save ( Writer writer)
          Save a dialog settings to a stream

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DialogSettings

public DialogSettings(
String sectionName)

Create an empty dialog settings which loads and saves its content to a file. Use the methods load(String) and store(String) to load and store this dialog settings.

Parameters:: sectionName - the name of the section in the settings.

Method Detail