Package org.nuiton.jaxx.runtime.swing.session

Class SwingSession

java.lang.Object

org.nuiton.jaxx.runtime.swing.session.SwingSession

public class SwingSession
extends Object

Use to store and restore position and size of application. Default supported widgets are:

• java.awt.Window (and subclasses)
• javax.swing.JTabbedPane (and subclasses)
• javax.swing.JSplitPane (and subclasses)
• org.jdesktop.swingx.JXTable (and subclasses)
• javax.swing.JTable (and subclasses)

usage:

• create SwingSession object
• add component that you want save
• explicite call to save

You can use same SwingSession for multiple window but in this case you must have setName for each window with different name, otherwize there are collision between window component and result is undetermisitic. This code is partialy inspired from http://kenai.com/projects/bsaf/pages/Home project. This project is under LGPL v2.1 license. We can't reuse directly this library because to many fields and methods are private and we can't implements it and modify some behavior.

Since:

2.5.16

Author:

poussin, kmorin

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SwingSession.Action
static class	SwingSession.RestoreStateAction
static class	SwingSession.SaveStateAction

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	autoSave
protected File	file
protected Set<Component>	registeredComponent
protected Map<Class,State>	stateManager	State object registered to get and set State.
protected Map<String,State>	states	state of all component added with add method.

Constructor Summary

Constructors

Constructor	Description
SwingSession(File file, boolean autoSave)
SwingSession(File file, boolean autoSave, Map<Class,State> additionalStates)

Method Summary

Modifier and Type	Method	Description
void	add(Component c)
void	add(Component c, boolean replace)
void	addToStateManager(Class component, State state)
protected void	finalize()
protected String	getComponentName(Component c)
File	getFile()
State	getStateManager(Class clazz)
State	getStates(String path)
void	loadSafeStates()	Loads safely the states from the file.
Map<String,State>	loadStates(File file)	Loads the states from the file
static SwingSession	newSession(File file, boolean autoSave)	Deprecated. since 2.10, the default behaviour is now to safely load the incoming file
static SwingSession	newSession(File file, boolean autoSave, Map<Class,State> additionalStates)	Deprecated. since 2.10, the default behaviour is now to safely load the incoming file
void	remove(Component c)	Remove component from component to save
void	save()
void	setFile(File file)
void	setStates(String path, State state)
void	updateState()
protected void	walkThrowComponent(String path, Collection<Component> roots, SwingSession.Action action)

Methods inherited from class java.lang.Object

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

Field Detail

file

protected File file

autoSave

protected final boolean autoSave

registeredComponent

protected final Set<Component> registeredComponent

stateManager

protected final Map<Class,State> stateManager

State object registered to get and set State. key: class of component managed by the state; value: the state

states

protected Map<String,State> states

state of all component added with add method. key: path of compoenent; value: State

Constructor Detail

SwingSession

public SwingSession(File file,
                    boolean autoSave)

SwingSession

public SwingSession(File file,
                    boolean autoSave,
                    Map<Class,State> additionalStates)

Method Detail

newSession

@Deprecated
public static SwingSession newSession(File file,
                                      boolean autoSave)

Deprecated.

since 2.10, the default behaviour is now to safely load the incoming file

Create a new swing session with the given parameters. If it fails to read the given file, then it will delete it from the fs and starts with a new empty file.

Returns:

the new swing session

Since:

2.8.6

newSession

@Deprecated
public static SwingSession newSession(File file,
                                      boolean autoSave,
                                      Map<Class,State> additionalStates)

Deprecated.

since 2.10, the default behaviour is now to safely load the incoming file

Create a new swing session with the given parameters. If it fails to read the given file, then it will delete it from the fs and starts with a new empty file.

Returns:

the new swing session

Since:

2.8.6

getFile

public File getFile()

setFile

public void setFile(File file)

loadSafeStates

public void loadSafeStates()

Loads safely the states from the file. If could not read the internal file, then will try to delete it.

Since:

2.10

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

save

public void save()
          throws IOException

Throws:

IOException

loadStates

public Map<String,State> loadStates(File file)
                                   throws IOException

Loads the states from the file

Throws:

IOException

updateState

public void updateState()

add

public void add(Component c)

add

public void add(Component c,
                boolean replace)

remove

public void remove(Component c)

Remove component from component to save

Parameters:

c -

getComponentName

protected String getComponentName(Component c)

getStateManager

public State getStateManager(Class clazz)

addToStateManager

public void addToStateManager(Class component,
                              State state)

getStates

public State getStates(String path)

setStates

public void setStates(String path,
                      State state)

walkThrowComponent

protected void walkThrowComponent(String path,
                                  Collection<Component> roots,
                                  SwingSession.Action action)