Module interacto.java.api

Package io.github.interacto.instrument

Class InstrumentImpl<T extends WidgetBinding<? extends Command>>

java.lang.Object

io.github.interacto.instrument.InstrumentImpl<T>

All Implemented Interfaces:

Instrument<T>, Modifiable, Preferenciable, Reinitialisable

public abstract class InstrumentImpl<T extends WidgetBinding<? extends Command>>
extends Object
implements Instrument<T>

The base class of an instrument.

Author:

Arnaud BLOUIN

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	activated	Defines whether the instrument is activated.
protected List<T>	bindings	The widget bindings of the instrument.
protected boolean	configured
protected Set<io.reactivex.disposables.Disposable>	disposables
protected boolean	modified	Defined whether the instrument has been modified.

Constructor Summary

Constructors

Constructor	Description
InstrumentImpl()	Creates and initialises the instrument.

Method Summary

Modifier and Type	Method	Description
void	addBinding(T binding)	Adds the given widget binding to the list of bindings of the instrument.
protected void	addDisposable(io.reactivex.disposables.Disposable disposable)	The instrument can store disposable objects that will be flushed on un-installation.
void	clearEvents()	Stops the interactions of the instrument and clears all its events waiting for a process.
protected abstract void	configureBindings()	Initialises the bindings of the instrument.
int	getNbWidgetBindings()
List<T>	getWidgetBindings()
boolean	hasWidgetBindings()
boolean	isActivated()
boolean	isModified()
void	load(boolean generalPreferences, String nsURI, Element meta)	Loads data save in an XML document.
void	reinit()	Reinitialises the object.
void	save(boolean generalPreferences, String nsURI, Document document, Element root)	Saves the parameters of the instrument into an XML tag.
void	setActivated(boolean toBeActivated)	Activates or deactivates the instrument.
void	setModified(boolean isModified)	Sets the Modifiable object as modified.
void	uninstallBindings()	Uninstall all the bindings of the instrument.

Methods inherited from class java.lang.Object

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

Field Detail

activated

protected boolean activated

Defines whether the instrument is activated.

bindings

protected final List<T extends WidgetBinding<? extends Command>> bindings

The widget bindings of the instrument.

modified

protected boolean modified

Defined whether the instrument has been modified.

disposables

protected final Set<io.reactivex.disposables.Disposable> disposables

configured

protected boolean configured

Constructor Detail

InstrumentImpl

public InstrumentImpl()

Creates and initialises the instrument.

Method Detail

addDisposable

protected void addDisposable(io.reactivex.disposables.Disposable disposable)

The instrument can store disposable objects that will be flushed on un-installation. This method stores a disposable object.

Parameters:

disposable - The disposable object to store. Nothing done if null.

getNbWidgetBindings

public int getNbWidgetBindings()

Specified by:

getNbWidgetBindings in interface Instrument<T extends WidgetBinding<? extends Command>>

Returns:

The number of widget bindings that compose the instrument.

hasWidgetBindings

public boolean hasWidgetBindings()

Specified by:

hasWidgetBindings in interface Instrument<T extends WidgetBinding<? extends Command>>

Returns:

True: the instrument has at least one widget binding. False otherwise.

getWidgetBindings

public List<T> getWidgetBindings()

Specified by:

getWidgetBindings in interface Instrument<T extends WidgetBinding<? extends Command>>

Returns:

The widget bindings that compose the instrument. Cannot be null.

configureBindings

protected abstract void configureBindings()

Initialises the bindings of the instrument.

addBinding

public void addBinding(T binding)

Adds the given widget binding to the list of bindings of the instrument.

Parameters:

binding - The widget binding to add. If null, nothing is done.

clearEvents

public void clearEvents()

Description copied from interface: Instrument

Stops the interactions of the instrument and clears all its events waiting for a process.

Specified by:

clearEvents in interface Instrument<T extends WidgetBinding<? extends Command>>

isActivated

public boolean isActivated()

Specified by:

isActivated in interface Instrument<T extends WidgetBinding<? extends Command>>

Returns:

True if the instrument is activated.

setActivated

public void setActivated(boolean toBeActivated)

Description copied from interface: Instrument

Activates or deactivates the instrument.

Specified by:

setActivated in interface Instrument<T extends WidgetBinding<? extends Command>>

Parameters:

toBeActivated - True = activation.

save

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

Description copied from interface: Preferenciable

Saves the parameters of the instrument into an XML tag.

Specified by:

save in interface Preferenciable

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

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

Description copied from interface: Preferenciable

Loads data save in an XML document.

Specified by:

load in interface Preferenciable

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.

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

meta - The meta data element.

isModified

public boolean isModified()

Specified by:

isModified in interface Modifiable

Returns:

True: the object has been modified. False otherwise.

setModified

public void setModified(boolean isModified)

Description copied from interface: Modifiable

Sets the Modifiable object as modified.

Specified by:

setModified in interface Modifiable

Parameters:

isModified - True: the element is will tagged as modified.

reinit

public void reinit()

Description copied from interface: Reinitialisable

Reinitialises the object.

Specified by:

reinit in interface Reinitialisable

uninstallBindings

public void uninstallBindings()

Description copied from interface: Instrument

Uninstall all the bindings of the instrument.

Specified by:

uninstallBindings in interface Instrument<T extends WidgetBinding<? extends Command>>