pub.vlsolutions.swing.toolbars

Class ToolBarIO

java.lang.Object

pub.vlsolutions.swing.toolbars.ToolBarIO

public class ToolBarIO
extends java.lang.Object

A utility class used to save and restore toolbars to/from an XML configuration.

Author:

Lilian Chamontin, VLSolutions

Constructor Summary

Constructors

Constructor and Description
ToolBarIO(ToolBarContainer container) Constructs a new ToolBarIO utility based on the given container

Method Summary

Methods

Modifier and Type	Method and Description
ToolBarIOReadInfo	readXML(java.io.InputStream in) Reads an XML encoded stream as the toolbar configuration.
void	writeXML(java.io.OutputStream stream) Saves the current toolbar configuration into an XML stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolBarIO

public ToolBarIO(ToolBarContainer container)

Constructs a new ToolBarIO utility based on the given container

Method Detail

writeXML

public void writeXML(java.io.OutputStream stream)
              throws java.io.IOException

Saves the current toolbar configuration into an XML stream.

The stream is not closed at the end of the operation.

Throws:

java.io.IOException

See Also:

readXML(InputStream)

readXML

public ToolBarIOReadInfo readXML(java.io.InputStream in)
                          throws javax.xml.parsers.ParserConfigurationException,
                                 java.io.IOException,
                                 org.xml.sax.SAXException

Reads an XML encoded stream as the toolbar configuration.

When the method returns, the container is totally reconfigured with possibly different toolbars at different positions.

Note : The VLToolBars of the stream must be registered with the registerToolBar method, prior readXML.

Also note that the container must already contain its ToolBarPanels before reading the configuration.

Dismisses all visible toolbars.

The stream is not closed at the end of the operation.

Returns:

a descriptor of the reading operation(useful for example to know the registered toolbars, that weren't loaded (missing) from the input file).

Throws:

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

See Also:

writeXML(OutputStream), ToolBarContainer.registerToolBar(VLToolBar)