JSR-043: JTAPI-1.4

javax.telephony.phone
Interface PhoneTerminalListener

All Superinterfaces:
java.util.EventListener, TerminalListener

public interface PhoneTerminalListener
extends TerminalListener

The PhoneTerminalListener interface reports all changes that happen to the phone components. This interface extends the TerminalListener interfaces.

Since:
1.4
See Also:
TerminalListener, PhoneTerminalEvent

Method Summary
 void terminalButtonInfoChanged(PhoneTerminalEvent event)
          The terminalButtonInfoChanged method is called to report that the information associated with a button component has changed.
 void terminalButtonPressed(PhoneTerminalEvent event)
          The terminalButtonPressed method is called to report that a button component has been pressed.
 void terminalButtonPressThresholdExceeded(PhoneTerminalEvent event)
          The terminalButtonPressThresholdExceeded method is called to report that a button was held longer than the threshold set with method PhoneButton.setButtonPressThreshold(int threshold).
 void terminalDisplayUpdated(PhoneTerminalEvent event)
          The terminalDispalyUpdated method is called to report that the contents of the display component has changed.
 void terminalHookswitchStateChanged(PhoneTerminalEvent event)
          The terminalHookswitchStateChanged method is called to report that the state of the hookswitch component has changed.
 void terminalLampModeChanged(PhoneTerminalEvent event)
          The terminalLampModeChanged method is called to report that the mode of the PhoneLamp has changed.
 void terminalMicrophoneGainChanged(PhoneTerminalEvent event)
          The terminalMicrophoneGaineChanged method is called to report that the gain of a PhoneMicrophone component has changed.
 void terminalRingerPatternChanged(PhoneTerminalEvent event)
          The terminalRingerPatternChanged method is called to report that the pattern of a PhoneRinger component has changed.
 void terminalRingerVolumeChanged(PhoneTerminalEvent event)
          The terminalRingerVolumeChanged method is called to report that the volume of a PhoneRinger component has changed.
 void terminalSpeakerVolumeChanged(PhoneTerminalEvent event)
          The terminalSpeakerVolumeChanged method is called to report that the volume of a PhoneSpeaker component has changed.
 
Methods inherited from interface javax.telephony.TerminalListener
terminalListenerEnded
 

Method Detail

terminalButtonInfoChanged

public void terminalButtonInfoChanged(PhoneTerminalEvent event)
The terminalButtonInfoChanged method is called to report that the information associated with a button component has changed.

Parameters:
event - A PhoneTerminalEvent with eventID PhoneTerminalEvent.PHONE_TERMINAL_BUTTON_INFO_EVENT.
See Also:
PhoneTerminalEvent.PHONE_TERMINAL_BUTTON_INFO_EVENT, PhoneButton, PhoneButton.getInfo()

terminalButtonPressed

public void terminalButtonPressed(PhoneTerminalEvent event)
The terminalButtonPressed method is called to report that a button component has been pressed.

Parameters:
event - A PhoneTerminalEvent with eventID PhoneTerminalEvent.PHONE_TERMINAL_BUTTON_PRESS_EVENT.
See Also:
PhoneTerminalEvent.PHONE_TERMINAL_BUTTON_PRESS_EVENT, PhoneButton.getInfo(), PhoneButton.buttonPress()

terminalDisplayUpdated

public void terminalDisplayUpdated(PhoneTerminalEvent event)
The terminalDispalyUpdated method is called to report that the contents of the display component has changed.

Parameters:
event - A PhoneTerminalEvent with eventID PhoneTerminalEvent.PHONE_TERMINAL_DISPLAY_UPDATE_EVENT.
See Also:
PhoneTerminalEvent.PHONE_TERMINAL_DISPLAY_UPDATE_EVENT, PhoneDisplay.getDisplay(int x, int y), PhoneDisplay.setDisplay(java.lang.String string, int x, int y)

terminalHookswitchStateChanged

public void terminalHookswitchStateChanged(PhoneTerminalEvent event)
The terminalHookswitchStateChanged method is called to report that the state of the hookswitch component has changed.

Parameters:
event - A PhoneTerminalEvent with eventID PhoneTerminalEvent.PHONE_TERMINAL_HOOKSWITCH_STATE_EVENT.
See Also:
PhoneTerminalEvent.PHONE_TERMINAL_HOOKSWITCH_STATE_EVENT, PhoneHookswitch.getHookSwitchState(), PhoneHookswitch.setHookSwitch(int hookSwitchState)

terminalLampModeChanged

public void terminalLampModeChanged(PhoneTerminalEvent event)
The terminalLampModeChanged method is called to report that the mode of the PhoneLamp has changed.

Parameters:
event - A PhoneTerminalEvent with eventID PhoneTerminalEvent.PHONE_TERMINAL_LAMP_MODE_EVENT.
See Also:
PhoneTerminalEvent.PHONE_TERMINAL_LAMP_MODE_EVENT, PhoneLamp.getMode(), PhoneLamp.setMode(int mode), PhoneLamp.getSupportedModes()

terminalMicrophoneGainChanged

public void terminalMicrophoneGainChanged(PhoneTerminalEvent event)
The terminalMicrophoneGaineChanged method is called to report that the gain of a PhoneMicrophone component has changed.

Parameters:
event - A PhoneTerminalEvent with eventID PhoneTerminalEvent.PHONE_TERMINAL_MICROPHONE_GAIN_EVENT.
See Also:
PhoneTerminalEvent.PHONE_TERMINAL_MICROPHONE_GAIN_EVENT, PhoneMicrophone, PhoneMicrophone.getGain(), PhoneMicrophone.setGain(int gain)

terminalRingerPatternChanged

public void terminalRingerPatternChanged(PhoneTerminalEvent event)
The terminalRingerPatternChanged method is called to report that the pattern of a PhoneRinger component has changed.

Parameters:
event - A PhoneTerminalEvent with eventID PhoneTerminalEvent.PHONE_TERMINAL_RINGER_PATTERN_EVENT.
See Also:
PhoneTerminalEvent.PHONE_TERMINAL_RINGER_PATTERN_EVENT, PhoneRinger.getRingerPattern(), PhoneRinger.setRingerPattern(int ringerPattern)

terminalRingerVolumeChanged

public void terminalRingerVolumeChanged(PhoneTerminalEvent event)
The terminalRingerVolumeChanged method is called to report that the volume of a PhoneRinger component has changed.

Parameters:
event - A PhoneTerminalEvent with eventID PhoneTerminalEvent.PHONE_TERMINAL_RINGER_VOLUME_EVENT.
See Also:
PhoneTerminalEvent.PHONE_TERMINAL_RINGER_VOLUME_EVENT, PhoneRinger.getRingerVolume(), PhoneRinger.setRingerVolume(int volume)

terminalSpeakerVolumeChanged

public void terminalSpeakerVolumeChanged(PhoneTerminalEvent event)
The terminalSpeakerVolumeChanged method is called to report that the volume of a PhoneSpeaker component has changed.

Parameters:
event - A PhoneTerminalEvent with eventID PhoneTerminalEvent.PHONE_TERMINAL_SPEAKER_VOLUME_EVENT.
See Also:
PhoneTerminalEvent.PHONE_TERMINAL_SPEAKER_VOLUME_EVENT, PhoneSpeaker.getVolume(), PhoneSpeaker.setVolume(int volume)

terminalButtonPressThresholdExceeded

public void terminalButtonPressThresholdExceeded(PhoneTerminalEvent event)
The terminalButtonPressThresholdExceeded method is called to report that a button was held longer than the threshold set with method PhoneButton.setButtonPressThreshold(int threshold).

Parameters:
event - A PhoneTerminalEvent with eventID PhoneTerminalEvent.PHONE_TERMINAL_BUTTON_PRESS_THRESHOLD_EXCEEDED_EVENT.

See Also:
PhoneTerminalEvent.PHONE_TERMINAL_BUTTON_PRESS_THRESHOLD_EXCEEDED_EVENT, PhoneButton.setButtonPressThreshold(int threshold)

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org