org.barrelorgandiscovery.editableinstrument

Class EditableInstrument

java.lang.Object

org.barrelorgandiscovery.editableinstrument.EditableInstrument

All Implemented Interfaces:

IEditableInstrument, Disposable

public class EditableInstrument
extends java.lang.Object
implements Disposable, IEditableInstrument

Utility class for managing the structures associated to the Instrument Editor ... this class can be passed to the several visual Components by reference ...

Field Summary

Fields inherited from interface org.barrelorgandiscovery.editableinstrument.IEditableInstrument

DEFAULT_PIPESTOPGROUPNAME

Constructor Summary

Constructors

Constructor and Description
EditableInstrument()

Method Summary

Modifier and Type	Method and Description
void	addListener(InstrumentDescriptionListener listener)
void	addListener(ScaleListener listener) Add a scale listener ...
void	addListener(SoundSampleListListener listener) Add sound sample list listener
void	addScript(InstrumentScript script) Add a script into the instrument
void	addSoundSample(SoundSample ss, java.lang.String pipeStopGroup)
void	clearDirty() clear instrument modified status
void	dispose() Dispose the resources associated to an object
InstrumentScript	findScript(java.lang.String name) Find a script associated to the instrument
InstrumentScript[]	findScriptsByType(InstrumentScript.InstrumentScriptType type) Find all the script of a specified type
java.lang.String	getInstrumentDescription() Get the instrument description
java.awt.Image	getInstrumentPicture() Get the instrument picture
java.lang.String	getName() Get the instrument name
SoundSample	getPercussionSoundSample(PercussionDef pd) Get the sample associated to a percussion sample
java.lang.String[]	getPipeStopGroupsAndRegisterName() Get the list of pipestop groups in the instrument
SampleMapping	getSampleMapping(java.lang.String pipeStopGroupAndRegister, SoundSample sample) Get the mapping associated with a pipestopgroup
Scale	getScale() Get the scale of the instrument
InstrumentScript[]	getScripts() get all the importer scripts asssociated to the instrument
java.util.List<SoundSample>	getSoundSampleList(java.lang.String pipeStopGroup) Get the sound sample List ...
boolean	isDirty() is the object has been modified since last clear ?
void	removeListener(InstrumentDescriptionListener listener)
void	removeListener(ScaleListener listener) Remove a scale listener
void	removeListener(SoundSampleListListener listener) Remove sound sample list listener
void	removeSampleMapping(java.lang.String pipeStopGroup, SoundSample sample) Remove a sound sample associated to a pipestopgroup
void	removeScript(java.lang.String name) Remove a script from the instrument
void	removeSoundSample(SoundSample ss, java.lang.String pipeStopGroup)
void	setInstrumentDescription(java.lang.String instrumentDescription) Define the instrument description
void	setInstrumentPicture(java.awt.Image instrumentPicture) Define the instrument picture
void	setName(java.lang.String name) Define the name of the instrument
void	setPercussionSoundSample(PercussionDef pd, SoundSample ss) define a sample associated to a percussion
SampleMapping	setSampleMapping(java.lang.String pipeStopGroup, SoundSample sample, int first, int end) Define a sound sample for a pipestopgroup
void	setScale(Scale scale) Define a new Scale associated to the instrument
protected void	toggleDirty() signal instrument is dirty

Methods inherited from class java.lang.Object

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

Constructor Detail

EditableInstrument

public EditableInstrument()

Method Detail

setScale

public void setScale(Scale scale)

Description copied from interface: IEditableInstrument

Define a new Scale associated to the instrument

Specified by:

setScale in interface IEditableInstrument

getScale

public Scale getScale()

Description copied from interface: IEditableInstrument

Get the scale of the instrument

Specified by:

getScale in interface IEditableInstrument

Returns:

setName

public void setName(java.lang.String name)

Description copied from interface: IEditableInstrument

Define the name of the instrument

Specified by:

setName in interface IEditableInstrument

getName

public java.lang.String getName()

Description copied from interface: IEditableInstrument

Get the instrument name

Specified by:

getName in interface IEditableInstrument

Returns:

getPipeStopGroupsAndRegisterName

public java.lang.String[] getPipeStopGroupsAndRegisterName()

Description copied from interface: IEditableInstrument

Get the list of pipestop groups in the instrument

Specified by:

getPipeStopGroupsAndRegisterName in interface IEditableInstrument

Returns:

addListener

public void addListener(ScaleListener listener)

Description copied from interface: IEditableInstrument

Add a scale listener ...

Specified by:

addListener in interface IEditableInstrument

removeListener

public void removeListener(ScaleListener listener)

Description copied from interface: IEditableInstrument

Remove a scale listener

Specified by:

removeListener in interface IEditableInstrument

addListener

public void addListener(SoundSampleListListener listener)

Description copied from interface: IEditableInstrument

Add sound sample list listener

Specified by:

addListener in interface IEditableInstrument

removeListener

public void removeListener(SoundSampleListListener listener)

Description copied from interface: IEditableInstrument

Remove sound sample list listener

Specified by:

removeListener in interface IEditableInstrument

addListener

public void addListener(InstrumentDescriptionListener listener)

Specified by:

addListener in interface IEditableInstrument

removeListener

public void removeListener(InstrumentDescriptionListener listener)

Specified by:

removeListener in interface IEditableInstrument

getSoundSampleList

public java.util.List<SoundSample> getSoundSampleList(java.lang.String pipeStopGroup)

Description copied from interface: IEditableInstrument

Get the sound sample List ...

Specified by:

getSoundSampleList in interface IEditableInstrument

Returns:

addSoundSample

public void addSoundSample(SoundSample ss,
                           java.lang.String pipeStopGroup)

Specified by:

addSoundSample in interface IEditableInstrument

removeSoundSample

public void removeSoundSample(SoundSample ss,
                              java.lang.String pipeStopGroup)

Specified by:

removeSoundSample in interface IEditableInstrument

getSampleMapping

public SampleMapping getSampleMapping(java.lang.String pipeStopGroupAndRegister,
                                      SoundSample sample)

Description copied from interface: IEditableInstrument

Get the mapping associated with a pipestopgroup

Specified by:

getSampleMapping in interface IEditableInstrument

Returns:

setSampleMapping

public SampleMapping setSampleMapping(java.lang.String pipeStopGroup,
                                      SoundSample sample,
                                      int first,
                                      int end)

Description copied from interface: IEditableInstrument

Define a sound sample for a pipestopgroup

Specified by:

setSampleMapping in interface IEditableInstrument

Parameters:

pipeStopGroup - the pipestopgroup

sample - the sample

first - the first note of the sample association

end - the last note of the sample association

Returns:

removeSampleMapping

public void removeSampleMapping(java.lang.String pipeStopGroup,
                                SoundSample sample)

Description copied from interface: IEditableInstrument

Remove a sound sample associated to a pipestopgroup

Specified by:

removeSampleMapping in interface IEditableInstrument

getInstrumentDescription

public java.lang.String getInstrumentDescription()

Description copied from interface: IEditableInstrument

Get the instrument description

Specified by:

getInstrumentDescription in interface IEditableInstrument

Returns:

setInstrumentDescription

public void setInstrumentDescription(java.lang.String instrumentDescription)

Description copied from interface: IEditableInstrument

Define the instrument description

Specified by:

setInstrumentDescription in interface IEditableInstrument

setInstrumentPicture

public void setInstrumentPicture(java.awt.Image instrumentPicture)

Description copied from interface: IEditableInstrument

Define the instrument picture

Specified by:

setInstrumentPicture in interface IEditableInstrument

getInstrumentPicture

public java.awt.Image getInstrumentPicture()

Description copied from interface: IEditableInstrument

Get the instrument picture

Specified by:

getInstrumentPicture in interface IEditableInstrument

Returns:

dispose

public void dispose()

Description copied from interface: Disposable

Dispose the resources associated to an object

Specified by:

dispose in interface IEditableInstrument

Specified by:

dispose in interface Disposable

isDirty

public boolean isDirty()

is the object has been modified since last clear ?

Specified by:

isDirty in interface IEditableInstrument

Returns:

clearDirty

public void clearDirty()

clear instrument modified status

Specified by:

clearDirty in interface IEditableInstrument

toggleDirty

protected void toggleDirty()

signal instrument is dirty

addScript

public void addScript(InstrumentScript script)

Add a script into the instrument

Specified by:

addScript in interface IEditableInstrument

Parameters:

script -

removeScript

public void removeScript(java.lang.String name)

Remove a script from the instrument

Specified by:

removeScript in interface IEditableInstrument

Parameters:

name -

findScript

public InstrumentScript findScript(java.lang.String name)

Find a script associated to the instrument

Specified by:

findScript in interface IEditableInstrument

Parameters:

name -

Returns:

findScriptsByType

public InstrumentScript[] findScriptsByType(InstrumentScript.InstrumentScriptType type)

Description copied from interface: IEditableInstrument

Find all the script of a specified type

Specified by:

findScriptsByType in interface IEditableInstrument

Returns:

getScripts

public InstrumentScript[] getScripts()

get all the importer scripts asssociated to the instrument

Specified by:

getScripts in interface IEditableInstrument

Returns:

setPercussionSoundSample

public void setPercussionSoundSample(PercussionDef pd,
                                     SoundSample ss)

Description copied from interface: IEditableInstrument

define a sample associated to a percussion

Specified by:

setPercussionSoundSample in interface IEditableInstrument

getPercussionSoundSample

public SoundSample getPercussionSoundSample(PercussionDef pd)

Description copied from interface: IEditableInstrument

Get the sample associated to a percussion sample

Specified by:

getPercussionSoundSample in interface IEditableInstrument