Module interacto.java.api

Package io.github.interacto.properties

Interface Preferenciable

All Known Subinterfaces:

Instrument<T>

All Known Implementing Classes:

InstrumentImpl

public interface Preferenciable

The interface can be applied on classes which can preferences can be saved into an XML document.

Author:

Arnaud BLOUIN

Method Summary

Modifier and Type	Method	Description
void	load(boolean generalPreferences, String nsURI, Element meta)	Loads data save in an XML document.
void	save(boolean generalPreferences, String nsURI, Document document, Element root)	Saves the parameters of the instrument into an XML tag.

Method Detail

save

void save(boolean generalPreferences,
          String nsURI,
          Document document,
          Element root)

Saves the parameters of the instrument into an XML tag.

Parameters:

generalPreferences - True: this operation is called to save the general preferences of the interactive system. Otherwise, it is called to save a presentation in a document. This parameter is useful when different information must be saved during a presentation backup or a general preferences backup.

nsURI - The namespace that must be added to tags corresponding to the instrument's parameters.

document - The XML document.

root - The root element that will contains the instrument's parameters.

load

void load(boolean generalPreferences,
          String nsURI,
          Element meta)

Loads data save in an XML document.

Parameters:

generalPreferences - True: this operation is called to load the general preferences of the interactive system. Otherwise, it is called to load a presentation in a document. This parameter is useful when different information must be loaded during a presentation backup or a general preferences backup.

meta - The meta data element.

nsURI - The namespace that must be added to tags corresponding to the instrument's parameters.