org.jfugue
Class Controller

java.lang.Object
  extended by org.jfugue.Controller
All Implemented Interfaces:
JFugueElement

public final class Controller
extends java.lang.Object
implements JFugueElement

Contains information for MIDI Controller Events.

Version:
2.0
Author:
David Koelle

Field Summary
static byte ALL_CONTROLLERS_OFF
           
static byte ALL_NOTES_OFF
           
static byte ALL_SOUND_OFF
           
static byte ATTACK_TIME
           
static int BALANCE
           
static byte BALANCE_COARSE
           
static byte BALANCE_FINE
           
static int BANK_SELECT
           
static byte BANK_SELECT_COARSE
           
static byte BANK_SELECT_FINE
           
static int BREATH
           
static byte BREATH_COARSE
           
static byte BREATH_FINE
           
static byte BRIGHTNESS
           
static byte BUTTON_1
           
static byte BUTTON_2
           
static byte BUTTON_3
           
static byte BUTTON_4
           
static byte BUTTON_DEC
           
static byte BUTTON_INC
           
static byte CELESTE
           
static byte CELESTE_LEVEL
           
static byte CHORUS
           
static byte CHORUS_LEVEL
           
static byte CONTROL_10
           
static byte CONTROL_6
           
static byte CONTROL_7
           
static byte CONTROL_8
           
static byte CONTROL_9
           
static byte DATA_BUTTON_DEC
           
static byte DATA_BUTTON_DECREMENT
           
static byte DATA_BUTTON_INC
           
static byte DATA_BUTTON_INCREMENT
           
static int DATA_ENTRY
           
static byte DATA_ENTRY_COARSE
           
static byte DATA_ENTRY_FINE
           
static byte DEFAULT
           
static int EFFECT_CONTROL_1
           
static byte EFFECT_CONTROL_1_COARSE
           
static byte EFFECT_CONTROL_1_FINE
           
static int EFFECT_CONTROL_2
           
static byte EFFECT_CONTROL_2_COARSE
           
static byte EFFECT_CONTROL_2_FINE
           
static byte EFFECTS
           
static byte EFFECTS_LEVEL
           
static int EXPRESSION
           
static byte EXPRESSION_COARSE
           
static byte EXPRESSION_FINE
           
static int FOOT_PEDAL
           
static byte FOOT_PEDAL_COARSE
           
static byte FOOT_PEDAL_FINE
           
static byte GENERAL_BUTTON_1
           
static byte GENERAL_BUTTON_2
           
static byte GENERAL_BUTTON_3
           
static byte GENERAL_BUTTON_4
           
static byte GENERAL_PURPOSE_BUTTON_1
           
static byte GENERAL_PURPOSE_BUTTON_2
           
static byte GENERAL_PURPOSE_BUTTON_3
           
static byte GENERAL_PURPOSE_BUTTON_4
           
static byte HOLD
           
static byte HOLD_2
           
static byte HOLD_2_PEDAL
           
static byte HOLD_PEDAL
           
static byte LEGATO
           
static byte LEGATO_PEDAL
           
static byte LOCAL_KEYBOARD
           
static int MOD_WHEEL
           
static byte MOD_WHEEL_COARSE
           
static byte MOD_WHEEL_FINE
           
static byte MONO
           
static byte MONO_OPERATION
           
static int NON_REGISTERED
           
static byte NON_REGISTERED_COARSE
           
static byte NON_REGISTERED_FINE
           
static byte OFF
           
static byte OMNI_MODE_OFF
           
static byte OMNI_MODE_ON
           
static byte OMNI_OFF
           
static byte OMNI_ON
           
static byte ON
           
static int PAN_POSITION
           
static byte PAN_POSITION_COARSE
           
static byte PAN_POSITION_FINE
           
static byte PHASER
           
static byte PHASER_LEVEL
           
static byte POLY
           
static byte POLY_OPERATION
           
static byte PORTAMENTO
           
static int PORTAMENTO_TIME
           
static byte PORTAMENTO_TIME_COARSE
           
static byte PORTAMENTO_TIME_FINE
           
static int REGISTERED
           
static byte REGISTERED_COARSE
           
static byte REGISTERED_FINE
           
static byte RELEASE_TIME
           
static byte SLIDER_1
           
static byte SLIDER_2
           
static byte SLIDER_3
           
static byte SLIDER_4
           
static byte SOFT
           
static byte SOFT_PEDAL
           
static byte SOUND_ATTACK_TIME
           
static byte SOUND_BRIGHTNESS
           
static byte SOUND_CONTROL_10
           
static byte SOUND_CONTROL_6
           
static byte SOUND_CONTROL_7
           
static byte SOUND_CONTROL_8
           
static byte SOUND_CONTROL_9
           
static byte SOUND_RELEASE_TIME
           
static byte SOUND_TIMBRE
           
static byte SOUND_VARIATION
           
static byte SUSTENUTO
           
static byte SUSTENUTO_PEDAL
           
static byte TIMBRE
           
static byte TREMULO
           
static byte TREMULO_LEVEL
           
static byte VARIATION
           
static int VOLUME
           
static byte VOLUME_COARSE
           
static byte VOLUME_FINE
           
 
Constructor Summary
Controller()
          Creates a new Controller object
Controller(byte index, byte value)
          Creates a new Controller object, with the specified controller index and value.
 
Method Summary
 byte getIndex()
          Returns the index of the controller event for this object.
 java.lang.String getMusicString()
          Returns the Music String representing this element and all of its settings.
 byte getValue()
          Returns the value of the controller event for this object.
 java.lang.String getVerifyString()
          Returns verification string in this format: Controller: index={#}, value={#}
 void setIndex(byte index)
          Sets the index of the controller event for this object.
 void setValue(byte value)
          Sets the value of the controller event for this object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BANK_SELECT_COARSE

public static final byte BANK_SELECT_COARSE
See Also:
Constant Field Values

MOD_WHEEL_COARSE

public static final byte MOD_WHEEL_COARSE
See Also:
Constant Field Values

BREATH_COARSE

public static final byte BREATH_COARSE
See Also:
Constant Field Values

FOOT_PEDAL_COARSE

public static final byte FOOT_PEDAL_COARSE
See Also:
Constant Field Values

PORTAMENTO_TIME_COARSE

public static final byte PORTAMENTO_TIME_COARSE
See Also:
Constant Field Values

DATA_ENTRY_COARSE

public static final byte DATA_ENTRY_COARSE
See Also:
Constant Field Values

VOLUME_COARSE

public static final byte VOLUME_COARSE
See Also:
Constant Field Values

BALANCE_COARSE

public static final byte BALANCE_COARSE
See Also:
Constant Field Values

PAN_POSITION_COARSE

public static final byte PAN_POSITION_COARSE
See Also:
Constant Field Values

EXPRESSION_COARSE

public static final byte EXPRESSION_COARSE
See Also:
Constant Field Values

EFFECT_CONTROL_1_COARSE

public static final byte EFFECT_CONTROL_1_COARSE
See Also:
Constant Field Values

EFFECT_CONTROL_2_COARSE

public static final byte EFFECT_CONTROL_2_COARSE
See Also:
Constant Field Values

SLIDER_1

public static final byte SLIDER_1
See Also:
Constant Field Values

SLIDER_2

public static final byte SLIDER_2
See Also:
Constant Field Values

SLIDER_3

public static final byte SLIDER_3
See Also:
Constant Field Values

SLIDER_4

public static final byte SLIDER_4
See Also:
Constant Field Values

BANK_SELECT_FINE

public static final byte BANK_SELECT_FINE
See Also:
Constant Field Values

MOD_WHEEL_FINE

public static final byte MOD_WHEEL_FINE
See Also:
Constant Field Values

BREATH_FINE

public static final byte BREATH_FINE
See Also:
Constant Field Values

FOOT_PEDAL_FINE

public static final byte FOOT_PEDAL_FINE
See Also:
Constant Field Values

PORTAMENTO_TIME_FINE

public static final byte PORTAMENTO_TIME_FINE
See Also:
Constant Field Values

DATA_ENTRY_FINE

public static final byte DATA_ENTRY_FINE
See Also:
Constant Field Values

VOLUME_FINE

public static final byte VOLUME_FINE
See Also:
Constant Field Values

BALANCE_FINE

public static final byte BALANCE_FINE
See Also:
Constant Field Values

PAN_POSITION_FINE

public static final byte PAN_POSITION_FINE
See Also:
Constant Field Values

EXPRESSION_FINE

public static final byte EXPRESSION_FINE
See Also:
Constant Field Values

EFFECT_CONTROL_1_FINE

public static final byte EFFECT_CONTROL_1_FINE
See Also:
Constant Field Values

EFFECT_CONTROL_2_FINE

public static final byte EFFECT_CONTROL_2_FINE
See Also:
Constant Field Values

HOLD_PEDAL

public static final byte HOLD_PEDAL
See Also:
Constant Field Values

HOLD

public static final byte HOLD
See Also:
Constant Field Values

PORTAMENTO

public static final byte PORTAMENTO
See Also:
Constant Field Values

SUSTENUTO_PEDAL

public static final byte SUSTENUTO_PEDAL
See Also:
Constant Field Values

SUSTENUTO

public static final byte SUSTENUTO
See Also:
Constant Field Values

SOFT_PEDAL

public static final byte SOFT_PEDAL
See Also:
Constant Field Values

SOFT

public static final byte SOFT
See Also:
Constant Field Values

LEGATO_PEDAL

public static final byte LEGATO_PEDAL
See Also:
Constant Field Values

LEGATO

public static final byte LEGATO
See Also:
Constant Field Values

HOLD_2_PEDAL

public static final byte HOLD_2_PEDAL
See Also:
Constant Field Values

HOLD_2

public static final byte HOLD_2
See Also:
Constant Field Values

SOUND_VARIATION

public static final byte SOUND_VARIATION
See Also:
Constant Field Values

VARIATION

public static final byte VARIATION
See Also:
Constant Field Values

SOUND_TIMBRE

public static final byte SOUND_TIMBRE
See Also:
Constant Field Values

TIMBRE

public static final byte TIMBRE
See Also:
Constant Field Values

SOUND_RELEASE_TIME

public static final byte SOUND_RELEASE_TIME
See Also:
Constant Field Values

RELEASE_TIME

public static final byte RELEASE_TIME
See Also:
Constant Field Values

SOUND_ATTACK_TIME

public static final byte SOUND_ATTACK_TIME
See Also:
Constant Field Values

ATTACK_TIME

public static final byte ATTACK_TIME
See Also:
Constant Field Values

SOUND_BRIGHTNESS

public static final byte SOUND_BRIGHTNESS
See Also:
Constant Field Values

BRIGHTNESS

public static final byte BRIGHTNESS
See Also:
Constant Field Values

SOUND_CONTROL_6

public static final byte SOUND_CONTROL_6
See Also:
Constant Field Values

CONTROL_6

public static final byte CONTROL_6
See Also:
Constant Field Values

SOUND_CONTROL_7

public static final byte SOUND_CONTROL_7
See Also:
Constant Field Values

CONTROL_7

public static final byte CONTROL_7
See Also:
Constant Field Values

SOUND_CONTROL_8

public static final byte SOUND_CONTROL_8
See Also:
Constant Field Values

CONTROL_8

public static final byte CONTROL_8
See Also:
Constant Field Values

SOUND_CONTROL_9

public static final byte SOUND_CONTROL_9
See Also:
Constant Field Values

CONTROL_9

public static final byte CONTROL_9
See Also:
Constant Field Values

SOUND_CONTROL_10

public static final byte SOUND_CONTROL_10
See Also:
Constant Field Values

CONTROL_10

public static final byte CONTROL_10
See Also:
Constant Field Values

GENERAL_PURPOSE_BUTTON_1

public static final byte GENERAL_PURPOSE_BUTTON_1
See Also:
Constant Field Values

GENERAL_BUTTON_1

public static final byte GENERAL_BUTTON_1
See Also:
Constant Field Values

BUTTON_1

public static final byte BUTTON_1
See Also:
Constant Field Values

GENERAL_PURPOSE_BUTTON_2

public static final byte GENERAL_PURPOSE_BUTTON_2
See Also:
Constant Field Values

GENERAL_BUTTON_2

public static final byte GENERAL_BUTTON_2
See Also:
Constant Field Values

BUTTON_2

public static final byte BUTTON_2
See Also:
Constant Field Values

GENERAL_PURPOSE_BUTTON_3

public static final byte GENERAL_PURPOSE_BUTTON_3
See Also:
Constant Field Values

GENERAL_BUTTON_3

public static final byte GENERAL_BUTTON_3
See Also:
Constant Field Values

BUTTON_3

public static final byte BUTTON_3
See Also:
Constant Field Values

GENERAL_PURPOSE_BUTTON_4

public static final byte GENERAL_PURPOSE_BUTTON_4
See Also:
Constant Field Values

GENERAL_BUTTON_4

public static final byte GENERAL_BUTTON_4
See Also:
Constant Field Values

BUTTON_4

public static final byte BUTTON_4
See Also:
Constant Field Values

EFFECTS_LEVEL

public static final byte EFFECTS_LEVEL
See Also:
Constant Field Values

EFFECTS

public static final byte EFFECTS
See Also:
Constant Field Values

TREMULO_LEVEL

public static final byte TREMULO_LEVEL
See Also:
Constant Field Values

TREMULO

public static final byte TREMULO
See Also:
Constant Field Values

CHORUS_LEVEL

public static final byte CHORUS_LEVEL
See Also:
Constant Field Values

CHORUS

public static final byte CHORUS
See Also:
Constant Field Values

CELESTE_LEVEL

public static final byte CELESTE_LEVEL
See Also:
Constant Field Values

CELESTE

public static final byte CELESTE
See Also:
Constant Field Values

PHASER_LEVEL

public static final byte PHASER_LEVEL
See Also:
Constant Field Values

PHASER

public static final byte PHASER
See Also:
Constant Field Values

DATA_BUTTON_INCREMENT

public static final byte DATA_BUTTON_INCREMENT
See Also:
Constant Field Values

DATA_BUTTON_INC

public static final byte DATA_BUTTON_INC
See Also:
Constant Field Values

BUTTON_INC

public static final byte BUTTON_INC
See Also:
Constant Field Values

DATA_BUTTON_DECREMENT

public static final byte DATA_BUTTON_DECREMENT
See Also:
Constant Field Values

DATA_BUTTON_DEC

public static final byte DATA_BUTTON_DEC
See Also:
Constant Field Values

BUTTON_DEC

public static final byte BUTTON_DEC
See Also:
Constant Field Values

NON_REGISTERED_COARSE

public static final byte NON_REGISTERED_COARSE
See Also:
Constant Field Values

NON_REGISTERED_FINE

public static final byte NON_REGISTERED_FINE
See Also:
Constant Field Values

REGISTERED_COARSE

public static final byte REGISTERED_COARSE
See Also:
Constant Field Values

REGISTERED_FINE

public static final byte REGISTERED_FINE
See Also:
Constant Field Values

ALL_SOUND_OFF

public static final byte ALL_SOUND_OFF
See Also:
Constant Field Values

ALL_CONTROLLERS_OFF

public static final byte ALL_CONTROLLERS_OFF
See Also:
Constant Field Values

LOCAL_KEYBOARD

public static final byte LOCAL_KEYBOARD
See Also:
Constant Field Values

ALL_NOTES_OFF

public static final byte ALL_NOTES_OFF
See Also:
Constant Field Values

OMNI_MODE_OFF

public static final byte OMNI_MODE_OFF
See Also:
Constant Field Values

OMNI_OFF

public static final byte OMNI_OFF
See Also:
Constant Field Values

OMNI_MODE_ON

public static final byte OMNI_MODE_ON
See Also:
Constant Field Values

OMNI_ON

public static final byte OMNI_ON
See Also:
Constant Field Values

MONO_OPERATION

public static final byte MONO_OPERATION
See Also:
Constant Field Values

MONO

public static final byte MONO
See Also:
Constant Field Values

POLY_OPERATION

public static final byte POLY_OPERATION
See Also:
Constant Field Values

POLY

public static final byte POLY
See Also:
Constant Field Values

BANK_SELECT

public static final int BANK_SELECT
See Also:
Constant Field Values

MOD_WHEEL

public static final int MOD_WHEEL
See Also:
Constant Field Values

BREATH

public static final int BREATH
See Also:
Constant Field Values

FOOT_PEDAL

public static final int FOOT_PEDAL
See Also:
Constant Field Values

PORTAMENTO_TIME

public static final int PORTAMENTO_TIME
See Also:
Constant Field Values

DATA_ENTRY

public static final int DATA_ENTRY
See Also:
Constant Field Values

VOLUME

public static final int VOLUME
See Also:
Constant Field Values

BALANCE

public static final int BALANCE
See Also:
Constant Field Values

PAN_POSITION

public static final int PAN_POSITION
See Also:
Constant Field Values

EXPRESSION

public static final int EXPRESSION
See Also:
Constant Field Values

EFFECT_CONTROL_1

public static final int EFFECT_CONTROL_1
See Also:
Constant Field Values

EFFECT_CONTROL_2

public static final int EFFECT_CONTROL_2
See Also:
Constant Field Values

NON_REGISTERED

public static final int NON_REGISTERED
See Also:
Constant Field Values

REGISTERED

public static final int REGISTERED
See Also:
Constant Field Values

ON

public static final byte ON
See Also:
Constant Field Values

OFF

public static final byte OFF
See Also:
Constant Field Values

DEFAULT

public static final byte DEFAULT
See Also:
Constant Field Values
Constructor Detail

Controller

public Controller()
Creates a new Controller object


Controller

public Controller(byte index,
                  byte value)
Creates a new Controller object, with the specified controller index and value.

Parameters:
index - the index of the controller to set
value - the byte value used to set the controller
Method Detail

setIndex

public void setIndex(byte index)
Sets the index of the controller event for this object.

Parameters:
index - the index of the controller

getIndex

public byte getIndex()
Returns the index of the controller event for this object.

Returns:
the index of the controller

setValue

public void setValue(byte value)
Sets the value of the controller event for this object.

Parameters:
value - the byte value used to set the controller

getValue

public byte getValue()
Returns the value of the controller event for this object.

Returns:
the value of the controller

getMusicString

public java.lang.String getMusicString()
Returns the Music String representing this element and all of its settings. For a Controller object, the Music String is Xindex=value

Specified by:
getMusicString in interface JFugueElement
Returns:
the Music String for this element

getVerifyString

public java.lang.String getVerifyString()
Returns verification string in this format: Controller: index={#}, value={#}

Specified by:
getVerifyString in interface JFugueElement