JSR-043: JTAPI-1.4

javax.telephony.phone
Interface PhoneButton

All Superinterfaces:
Component

public interface PhoneButton
extends Component

Phone button interface.


Method Summary
 void buttonPress()
          Press the button.
 PhoneLamp getAssociatedPhoneLamp()
          Returns the associated lamp information.
 int getButtonPressThreshold()
          Return the button press duration threshold.
 java.lang.String getInfo()
          Returns the button information.
 int setButtonPressThreshold(int threshold)
          Set the button press duration threshold.
 void setInfo(java.lang.String buttonInfo)
          Sets button information.
 
Methods inherited from interface javax.telephony.phone.Component
getCapabilities, getName
 

Method Detail

getInfo

public java.lang.String getInfo()
Returns the button information.

Returns:
The string button information.

setInfo

public void setInfo(java.lang.String buttonInfo)
Sets button information.

Parameters:
buttonInfo - The button information.

getAssociatedPhoneLamp

public PhoneLamp getAssociatedPhoneLamp()
Returns the associated lamp information.

Returns:
The associated lamp object.

buttonPress

public void buttonPress()
Press the button.


setButtonPressThreshold

public int setButtonPressThreshold(int threshold)
Set the button press duration threshold. When a button is pressed and held for this duration or longer, an application may wish to take special action. By setting this threshold value (in milliseconds) the application asks that an event be sent indicating that the button was pressed and held "for a long time."

The default threshold is ISSUE: implementation dependent (should we pick a number, like 1000 millisec?); if the threshold is set to 0, the PHONE_TERMINAL_BUTTON_PRESS_THRESHOLD_EXCEEDED_EVENT event is sent immediately after PHONE_TERMINAL_BUTTON_PRESS_EVENT. th

Since:
1.4

getButtonPressThreshold

public int getButtonPressThreshold()
Return the button press duration threshold.

Since:
1.4

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org