net.java.sip.communicator.impl.gui.main.call
Interface CallPeerRenderer

All Known Subinterfaces:

ConferenceCallPeerRenderer

All Known Implementing Classes:

ConferenceFocusPanel, ConferencePeerPanel, OneToOneCallPeerPanel

public interface CallPeerRenderer

The CallPeerRenderer interface is meant to be implemented by different renderers of CallPeers. Through this interface they would could be updated in order to reflect the current state of the CallPeer.

Author:

Yana Stamcheva

Method Summary

CallPanel	getCallPanel() Returns the parent CallPanel containing this renderer.
CallPeerAdapter	getCallPeerAdapter() Returns the call peer adapter that manages all related listeners.
CallRenderer	getCallRenderer() Returns the parent call renderer.
Component	getComponent() Returns the component associated with this renderer.
UIVideoHandler	getVideoHandler() Returns the video handler associated with this call peer renderer.
boolean	isLocalVideoVisible() Indicates if the local video component is currently visible.
void	printDTMFTone(char dtmfChar) Prints the given DTMG character through this CallPeerRenderer.
void	securityNegotiationStarted(CallPeerSecurityNegotiationStartedEvent securityStartedEvent) The handler for the security event received.
void	securityOff(CallPeerSecurityOffEvent evt) Indicates that the security is turned off.
void	securityOn(CallPeerSecurityOnEvent evt) Indicates that the security is turned on.
void	securityPending() Indicates that the security status is pending confirmation.
void	securityTimeout(CallPeerSecurityTimeoutEvent evt) Indicates that the security is timeouted, is not supported by the other end.
void	setCallPeerAdapter(CallPeerAdapter adapter) Sets the call peer adapter that manages all related listeners.
void	setErrorReason(String reason) Sets the reason of a call failure if one occurs.
void	setLocalVideoVisible(boolean isVisible) Shows/hides the local video component.
void	setMute(boolean isMute) Sets the mute property value.
void	setOnHold(boolean isOnHold) Sets the "on hold" property value.
void	setPeerImage(byte[] image) Sets the image of the peer.
void	setPeerName(String name) Sets the name of the peer.
void	setPeerState(CallPeerState oldState, CallPeerState newState, String stateString) Sets the state of the contained call peer by specifying the state name.
void	setSecurityPanelVisible(boolean isVisible) Shows/hides the security panel.

Method Detail

setPeerName

void setPeerName(String name)

Sets the name of the peer.

Parameters:

name - the name of the peer

setPeerImage

void setPeerImage(byte[] image)

Sets the image of the peer.

Parameters:

image - the image to set

setPeerState

void setPeerState(CallPeerState oldState,
                  CallPeerState newState,
                  String stateString)

Sets the state of the contained call peer by specifying the state name.

Parameters:

oldState - the previous state of the peer

newState - the new state of the peer

stateString - the state of the contained call peer

setErrorReason

void setErrorReason(String reason)

Sets the reason of a call failure if one occurs. The renderer should display this reason to the user.

Parameters:

reason - the reason of the error to set

setMute

void setMute(boolean isMute)

Sets the mute property value.

Parameters:

isMute - indicates if the call with this peer is muted

setOnHold

void setOnHold(boolean isOnHold)

Sets the "on hold" property value.

Parameters:

isOnHold - indicates if the call with this peer is put on hold

securityOn

void securityOn(CallPeerSecurityOnEvent evt)

Indicates that the security is turned on.

Parameters:

evt - Details about the event that caused this message.

securityOff

void securityOff(CallPeerSecurityOffEvent evt)

Indicates that the security is turned off.

Parameters:

evt - Details about the event that caused this message.

securityPending

void securityPending()

Indicates that the security status is pending confirmation.

securityTimeout

void securityTimeout(CallPeerSecurityTimeoutEvent evt)

Indicates that the security is timeouted, is not supported by the other end.

Parameters:

evt - Details about the event that caused this message.

securityNegotiationStarted

void securityNegotiationStarted(CallPeerSecurityNegotiationStartedEvent securityStartedEvent)

The handler for the security event received. The security event for starting establish a secure connection.

Parameters:

securityStartedEvent - the security started event received

setCallPeerAdapter

void setCallPeerAdapter(CallPeerAdapter adapter)

Sets the call peer adapter that manages all related listeners.

Parameters:

adapter - the call peer adapter

getCallPeerAdapter

CallPeerAdapter getCallPeerAdapter()

Returns the call peer adapter that manages all related listeners.

Returns:

the call peer adapter

printDTMFTone

void printDTMFTone(char dtmfChar)

Prints the given DTMG character through this CallPeerRenderer.

Parameters:

dtmfChar - the DTMF char to print

getCallPanel

CallPanel getCallPanel()

Returns the parent CallPanel containing this renderer.

Returns:

the parent CallPanel containing this renderer

getCallRenderer

CallRenderer getCallRenderer()

Returns the parent call renderer.

Returns:

the parent call renderer

getComponent

Component getComponent()

Returns the component associated with this renderer.

Returns:

the component associated with this renderer

setLocalVideoVisible

void setLocalVideoVisible(boolean isVisible)

Shows/hides the local video component.

Parameters:

isVisible - true to show the local video, false - otherwise

isLocalVideoVisible

boolean isLocalVideoVisible()

Indicates if the local video component is currently visible.

Returns:

true if the local video component is currently visible, false - otherwise

getVideoHandler

UIVideoHandler getVideoHandler()

Returns the video handler associated with this call peer renderer.

Returns:

the video handler associated with this call peer renderer

setSecurityPanelVisible

void setSecurityPanelVisible(boolean isVisible)

Shows/hides the security panel.

Parameters:

isVisible - true to show the security panel, false to hide it