com.jidesoft.action
Class DockableBarPersistenceUtils

java.lang.Object
  com.jidesoft.action.DockableBarPersistenceUtils

public class DockableBarPersistenceUtils
extends Object

The docking persistence utility class to save/load docking layout to/from XML format stream or file.

Constructor Summary

DockableBarPersistenceUtils()

Method Summary

static void	load(DefaultDockableBarManager manager, Document document, PersistenceUtilsCallback.Load callback) Loads the docking manager from the document.
static void	load(DefaultDockableBarManager manager, InputStream in)
static void	load(DefaultDockableBarManager manager, InputStream in, PersistenceUtilsCallback.Load callback)
static void	load(DefaultDockableBarManager manager, String fileName)
static void	load(DefaultDockableBarManager manager, String fileName, PersistenceUtilsCallback.Load callback)
static void	save(DefaultDockableBarManager manager, OutputStream out) Saves the DefaultDockingManager's layout to an output stream.
static void	save(DefaultDockableBarManager manager, OutputStream out, String encoding) Saves the DefaultDockingManager's layout to an output stream.
static void	save(DefaultDockableBarManager manager, OutputStream out, String encoding, PersistenceUtilsCallback.Save callback) Saves the DefaultDockingManager's layout to an output stream.
static Document	save(DefaultDockableBarManager manager, PersistenceUtilsCallback.Save callback) Save the docking manager to a Document.
static void	save(DefaultDockableBarManager manager, String fileName) Saves the DefaultDockingManager's layout to a file.
static void	save(DefaultDockableBarManager manager, String fileName, String encoding) Saves the DefaultDockingManager's layout to a file.
static void	save(DefaultDockableBarManager manager, String fileName, String encoding, PersistenceUtilsCallback.Save callback) Saves the DefaultDockingManager's layout to a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockableBarPersistenceUtils

public DockableBarPersistenceUtils()

Method Detail

save

public static void save(DefaultDockableBarManager manager,
                        String fileName)
                 throws ParserConfigurationException,
                        IOException

Saves the DefaultDockingManager's layout to a file.

It's a thread safe method for you to use.

Parameters:

manager - the docking manager

fileName - the file name

Throws:

ParserConfigurationException - if a DocumentBuilder cannot be created which satisfies the configuration

IOException - If the pathname argument is null or any IO errors happen

save

public static void save(DefaultDockableBarManager manager,
                        String fileName,
                        String encoding)
                 throws ParserConfigurationException,
                        IOException

Saves the DefaultDockingManager's layout to a file.

It's a thread safe method for you to use.

Parameters:

manager - the docking manager

fileName - the file name

encoding - the encoding choice. It would be UTF-8 in default if you call the method without this parameter.

Throws:

ParserConfigurationException - if a DocumentBuilder cannot be created which satisfies the configuration

IOException - If the pathname argument is null or any IO errors happen

save

public static void save(DefaultDockableBarManager manager,
                        String fileName,
                        String encoding,
                        PersistenceUtilsCallback.Save callback)
                 throws ParserConfigurationException,
                        IOException

Saves the DefaultDockingManager's layout to a file.

It's a thread safe method for you to use.

Parameters:

manager - the docking manager

fileName - the file name

encoding - the encoding choice. It would be UTF-8 in default if you call the method without this parameter.

callback - the callback which will be called when saving each element to the XML document.

Throws:

ParserConfigurationException - if a DocumentBuilder cannot be created which satisfies the configuration

IOException - If the pathname argument is null or any IO errors happen

save

public static void save(DefaultDockableBarManager manager,
                        OutputStream out)
                 throws ParserConfigurationException,
                        IOException

Saves the DefaultDockingManager's layout to an output stream.

It's a thread safe method for you to use.

Parameters:

manager - the docking manager

out - the output stream

Throws:

ParserConfigurationException - if a DocumentBuilder cannot be created which satisfies the configuration

IOException - If the pathname argument is null or any IO errors happen

save

public static void save(DefaultDockableBarManager manager,
                        OutputStream out,
                        String encoding)
                 throws ParserConfigurationException,
                        IOException

Saves the DefaultDockingManager's layout to an output stream.

It's a thread safe method for you to use.

Parameters:

manager - the docking manager

out - the output stream

encoding - the encoding choice. It would be UTF-8 in default if you call the method without this parameter.

Throws:

ParserConfigurationException - if a DocumentBuilder cannot be created which satisfies the configuration

IOException - If the pathname argument is null or any IO errors happen

save

public static void save(DefaultDockableBarManager manager,
                        OutputStream out,
                        String encoding,
                        PersistenceUtilsCallback.Save callback)
                 throws ParserConfigurationException,
                        IOException

Saves the DefaultDockingManager's layout to an output stream.

It's a thread safe method for you to use.

Parameters:

manager - the docking manager

out - the output stream

encoding - the encoding choice. It would be UTF-8 in default if you call the method without this parameter.

callback - the callback which will be called when saving each element to the XML document.

Throws:

ParserConfigurationException - if a DocumentBuilder cannot be created which satisfies the configuration

IOException - If the pathname argument is null or any IO errors happen

save

public static Document save(DefaultDockableBarManager manager,
                            PersistenceUtilsCallback.Save callback)
                     throws ParserConfigurationException

Save the docking manager to a Document.

Please be noted that you have to invoke this method inside EDT.

Parameters:

manager - the docking manager

callback - the callback which will be called when saving each element to the XML document.

Returns:

the XML document.

Throws:

ParserConfigurationException - if there is any parser configuration issue.

load

public static void load(DefaultDockableBarManager manager,
                        InputStream in)
                 throws ParserConfigurationException,
                        SAXException,
                        IOException

Throws:

ParserConfigurationException

SAXException

IOException

load

public static void load(DefaultDockableBarManager manager,
                        InputStream in,
                        PersistenceUtilsCallback.Load callback)
                 throws ParserConfigurationException,
                        SAXException,
                        IOException

Throws:

ParserConfigurationException

SAXException

IOException

load

public static void load(DefaultDockableBarManager manager,
                        String fileName)
                 throws ParserConfigurationException,
                        SAXException,
                        IOException

Throws:

ParserConfigurationException

SAXException

IOException

load

public static void load(DefaultDockableBarManager manager,
                        String fileName,
                        PersistenceUtilsCallback.Load callback)
                 throws ParserConfigurationException,
                        SAXException,
                        IOException

Throws:

ParserConfigurationException

SAXException

IOException

load

public static void load(DefaultDockableBarManager manager,
                        Document document,
                        PersistenceUtilsCallback.Load callback)

Loads the docking manager from the document.

Parameters:

manager - the DefaultDockingManager

document - the document to be loaded

callback - the load callback