org.freehep.jas.plugin.xmlio
Interface XMLPluginIO

All Known Implementing Classes:
FTreePlugin, PlotterPlugin

public interface XMLPluginIO

This interface is to be implemented by all plugins that want their configuration to be saved and restored to xml. Each plugin is responsible to save any item that it created in the MasterTree, in the window manager, in plot pages etc etc. The reloading of the configuration is done in steps to ensure that all the object dependencies are properly handled. The first step of the reloading process is to ask all the plugins to open the data structures on which all the other objects (like plots, pages, editors) depend on. Each plugin is called for the initialization phase and should tell the XMLIOManager at which restore level it should be called back.

Author:
The FreeHEP team @ SLAC

Field Summary
static int RESTORE_DATA
           
static int RESTORE_DONE
           
static int RESTORE_FINALIZE
           
static int RESTORE_PAGES
           
static int RESTORE_PLOT_DATA_SOURCES
           
static int RESTORE_PLOTS_IN_PAGES
           
static int RESTORE_TREE_OBJECTS
           
static int RESTORE_TREE_STRUCTURE
           
 
Method Summary
 int restore(int level, org.freehep.xml.io.XMLIOManager manager, org.jdom.Element el)
          level is the level at which the restore should be performed.
 void save(org.freehep.xml.io.XMLIOManager manager, org.jdom.Element el)
           
 

Field Detail

RESTORE_DONE

static final int RESTORE_DONE
See Also:
Constant Field Values

RESTORE_DATA

static final int RESTORE_DATA
See Also:
Constant Field Values

RESTORE_TREE_OBJECTS

static final int RESTORE_TREE_OBJECTS
See Also:
Constant Field Values

RESTORE_PLOT_DATA_SOURCES

static final int RESTORE_PLOT_DATA_SOURCES
See Also:
Constant Field Values

RESTORE_PAGES

static final int RESTORE_PAGES
See Also:
Constant Field Values

RESTORE_PLOTS_IN_PAGES

static final int RESTORE_PLOTS_IN_PAGES
See Also:
Constant Field Values

RESTORE_TREE_STRUCTURE

static final int RESTORE_TREE_STRUCTURE
See Also:
Constant Field Values

RESTORE_FINALIZE

static final int RESTORE_FINALIZE
See Also:
Constant Field Values
Method Detail

save

void save(org.freehep.xml.io.XMLIOManager manager,
          org.jdom.Element el)

restore

int restore(int level,
            org.freehep.xml.io.XMLIOManager manager,
            org.jdom.Element el)
level is the level at which the restore should be performed. Levels: 0 - the initial level. At this level all the data should be restored. This level MUST be present!!! > 100 - final state restoring: finishing touches on the tree, order of the panels on the plot area and console area.



Copyright © 2013. All Rights Reserved.