SwingSession (JAXX :: Runtime 2.9 API)

java.lang.Object
- 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
Last update: $Date$ by : $Author$
Version:: $Revision$
Author:: poussin, kmorin

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field and 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 and Description
`SwingSession(File file, boolean autoSave)`
`SwingSession(File file, boolean autoSave, Map<Class,State> additionalStates)`

Method Summary

Methods
Modifier and Type	Method and 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)`
`Map<String,State>`	`loadStates(File file)` Loads the states from the file
`static SwingSession`	`newSession(File file, boolean autoSave)` Create a new swing session with the given parameters.
`static SwingSession`	`newSession(File file, boolean autoSave, Map<Class,State> additionalStates)` Create a new swing session with the given parameters.
`void`	`remove(Component c)` Remove component from component to save
`void`	`save()`
`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 boolean autoSave
```
- registeredComponent
```
protected Set<Component> registeredComponent
```
- stateManager
```
protected 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)
             throws IOException

Throws:: IOException

SwingSession

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

Throws:: IOException

Method Detail

newSession
```
public static SwingSession newSession(File file,
                      boolean autoSave)
```
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
```
public static SwingSession newSession(File file,
                      boolean autoSave,
                      Map<Class,State> additionalStates)
```
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()
```

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)

Class SwingSession

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

file

autoSave

registeredComponent

stateManager

states

Constructor Detail

SwingSession

SwingSession

Method Detail

newSession

newSession

getFile

finalize

save

loadStates

updateState

add

add

remove

getComponentName

getStateManager

addToStateManager

getStates

setStates

walkThrowComponent