de.cismet.commons.gui.equalizer

Interface EqualizerModel

All Known Implementing Classes:

AbstractEqualizerModel, DefaultEqualizerModel, RubberBandEqualizerModel

public interface EqualizerModel

Basic equalizer model interface that ensures that all necessary values can be accessed and altered.

Version:

1.0

Author:

martin.scholl@cismet.de

Method Summary

Modifier and Type	Method and Description
void	addEqualizerModelListener(EqualizerModelListener eml) Adds a new EqualizerModelListener to this model.
String	getEqualizerCategory(int index) Getter for the category name at the specified index.
int	getEqualizerCategoryCount() Getter for the total amount of available categories.
Range	getRange() Getter for the range this equalizer model covers (boundaries included).
int	getValueAt(int index) Getter for the current value at the specified index.
void	removeEqualizerModelListener(EqualizerModelListener eml) Remove the specified EqualizerModelListener.
void	setValueAt(int index, int value) Setter for the a new value at the specified index.

Method Detail

getRange

Range getRange()

Getter for the range this equalizer model covers (boundaries included). Shall never change.

Returns:

the immutable Range this model covers

getEqualizerCategory

String getEqualizerCategory(int index)

Getter for the category name at the specified index. Shall throw IndexOutOfBoundsException if index is < 0 or >= getEqualizerCategoryCount().

Parameters:

index - the category index

Returns:

the name of the category at the specified index

getEqualizerCategoryCount

int getEqualizerCategoryCount()

Getter for the total amount of available categories.

Returns:

the total amount of available categories

getValueAt

int getValueAt(int index)

Getter for the current value at the specified index. Shall throw IndexOutOfBoundsException if index is < 0 or >= getEqualizerCategoryCount().

Parameters:

index - the category index

Returns:

the current value at the specified index

setValueAt

void setValueAt(int index,
                int value)

Setter for the a new value at the specified index. The value has to be within the Range of this model. Otherwise an IllegalArgumentException shall be thrown. Shall throw IndexOutOfBoundsException if index is < 0 or >= getEqualizerCategoryCount().

Parameters:

index - the category index

value - the new value

addEqualizerModelListener

void addEqualizerModelListener(EqualizerModelListener eml)

Adds a new EqualizerModelListener to this model. Any registered listener will be informed of model changes. If a listener has already been added any subsequent calls with the same instance shall be ignore. This means that any listener shall only be called once when a change happens. If null is passed nothing shall be done.

Parameters:

eml - the EqualizerModelListener to add

removeEqualizerModelListener

void removeEqualizerModelListener(EqualizerModelListener eml)

Remove the specified EqualizerModelListener. It will not be informed of changes anymore. If there is no such listener or if null is passed nothing shall be done.

Parameters:

eml - the EqualizerModelListener to remove