org.gradle.gradleplugin.userinterface.swing.common

Class PreferencesAssistant

java.lang.Object

org.gradle.gradleplugin.userinterface.swing.common.PreferencesAssistant

public class PreferencesAssistant
extends Object

This class just helps do some of the mundane tasks of saving and restoring the location of something.

Author:

mhunsicker

Constructor Summary

Constructors

Constructor and Description
PreferencesAssistant()

Method Summary

Methods

Modifier and Type	Method and Description
static void	restoreSettings(SettingsNode settingsNode, JFileChooser fileChooser, String id, Class fileChooserClass)
static void	restoreSettings(SettingsNode settingsNode, JFrame frame, String id, Class windowClass) This restores the position of a frame.
static void	restoreSettings(SettingsNode settingsNode, JSplitPane splitter, String id, Class splitterClass)
static SettingsNode	restoreSettings(SettingsNode settingsNode, Window window, String id, Class windowClass) Call this to restore the preferences that were saved via a call to save settings.
static void	saveSettings(SettingsNode settingsNode, JFileChooser fileChooser, String id, Class fileChooserClass, boolean saveCurrentDirectoryVsSelectedFilesParent) Saves the settings of the file chooser; and by settings I mean the 'last visited directory'.
static void	saveSettings(SettingsNode settingsNode, JFrame frame, String id, Class windowClass) This version works for frames.
static void	saveSettings(SettingsNode settingsNode, JSplitPane splitter, String id, Class splitterClass)
static SettingsNode	saveSettings(SettingsNode settingsNode, Window window, String id, Class windowClass)

Methods inherited from class java.lang.Object

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

Constructor Detail

PreferencesAssistant

public PreferencesAssistant()

Method Detail

saveSettings

public static SettingsNode saveSettings(SettingsNode settingsNode,
                        Window window,
                        String id,
                        Class windowClass)

saveSettings

public static void saveSettings(SettingsNode settingsNode,
                JFrame frame,
                String id,
                Class windowClass)

This version works for frames. It makes sure it doesn't save the extended state (maximized, iconified, etc) if its iconified. Doing so, causes problems when its restored.

restoreSettings

public static SettingsNode restoreSettings(SettingsNode settingsNode,
                           Window window,
                           String id,
                           Class windowClass)

Call this to restore the preferences that were saved via a call to save settings. Note: if no preferences are found it doesn't do anything.

Parameters:

window - the window who's settings to save

id - a unique ID for these settings.

windowClass - Any class. Just used for the preferences mechanism to obtain an instance. Making this an argument gives you more flexibility.

restoreSettings

public static void restoreSettings(SettingsNode settingsNode,
                   JFrame frame,
                   String id,
                   Class windowClass)

This restores the position of a frame. We not only restore the size, but we'll maximize it if its was maximized when saved.

saveSettings

public static void saveSettings(SettingsNode settingsNode,
                JSplitPane splitter,
                String id,
                Class splitterClass)

restoreSettings

public static void restoreSettings(SettingsNode settingsNode,
                   JSplitPane splitter,
                   String id,
                   Class splitterClass)

saveSettings

public static void saveSettings(SettingsNode settingsNode,
                JFileChooser fileChooser,
                String id,
                Class fileChooserClass,
                boolean saveCurrentDirectoryVsSelectedFilesParent)

Saves the settings of the file chooser; and by settings I mean the 'last visited directory'.

Parameters:

saveCurrentDirectoryVsSelectedFilesParent - this should be true true if you're selecting only directories, false if you're selecting only files. I don't know what if you allow both.

restoreSettings

public static void restoreSettings(SettingsNode settingsNode,
                   JFileChooser fileChooser,
                   String id,
                   Class fileChooserClass)