cvm.uci.ui.gui.creator
Class SidePanelShell

java.lang.Object
  cvm.uci.ui.gui.creator.SidePanelShell

public class SidePanelShell
extends java.lang.Object

SidePanelShell is the shell that contains the communication interface. Date: February 03, 2010

Author:

Frank Hernandez, The Fallen of CVM

Constructor Summary

SidePanelShell()

Method Summary

boolean	addFileToCommunication(java.lang.String appID, java.lang.String fileName) This method adds a file link to a given communication.
boolean	addFormToCommunication(java.lang.String appID, java.lang.String formName) This method adds a form link to a given communication.
void	addNewApp(Application app)
boolean	addParticipantToApplication(java.lang.String appID, java.lang.String userName)
void	addParticipantToCurrentApplication(java.lang.String userName) This method adds a participant to the currently active application.
void	dispose()
ApplicationComposite	getApplicationComposite(java.lang.String appID) This method returns the Application composite for a given application ID.
static SidePanelShell	getCurrent() This method returns a reference to the last created object.
ApplicationComposite	getCurrentApplicationComposite()
java.util.List	getCurrentAppParticipants() This method returns the list of participants for the current active application.
java.lang.String	getCurrentTabCommID()
org.eclipse.swt.widgets.Shell	getShell()
void	hide()
void	init()
boolean	isVisible()
void	removeApp(java.lang.String connID)
boolean	removeParticipantFromApplication(java.lang.String appID, java.lang.String userName) This method removes the given participant from the give application list.
void	show()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SidePanelShell

public SidePanelShell()

Method Detail

getCurrent

public static SidePanelShell getCurrent()

This method returns a reference to the last created object.

Returns:

latest instance of SidePanelShell.

show

public void show()

hide

public void hide()

isVisible

public boolean isVisible()

dispose

public void dispose()

init

public void init()

addNewApp

public void addNewApp(Application app)

removeApp

public void removeApp(java.lang.String connID)

getShell

public org.eclipse.swt.widgets.Shell getShell()

getCurrentTabCommID

public java.lang.String getCurrentTabCommID()

getCurrentApplicationComposite

public ApplicationComposite getCurrentApplicationComposite()

addParticipantToApplication

public boolean addParticipantToApplication(java.lang.String appID,
                                           java.lang.String userName)

removeParticipantFromApplication

public boolean removeParticipantFromApplication(java.lang.String appID,
                                                java.lang.String userName)

This method removes the given participant from the give application list.

Parameters:

appID -

userName -

Returns:

true on success

addParticipantToCurrentApplication

public void addParticipantToCurrentApplication(java.lang.String userName)

This method adds a participant to the currently active application.

Parameters:

userName -

getCurrentAppParticipants

public java.util.List getCurrentAppParticipants()

This method returns the list of participants for the current active application.

Returns:

list of participants in currently active communication.

getApplicationComposite

public ApplicationComposite getApplicationComposite(java.lang.String appID)

This method returns the Application composite for a given application ID.

Parameters:

appID -

Returns:

composite of requested communication, null if none

addFormToCommunication

public boolean addFormToCommunication(java.lang.String appID,
                                      java.lang.String formName)

This method adds a form link to a given communication.

Parameters:

appID -

formName -

Returns:

true no success.

addFileToCommunication

public boolean addFileToCommunication(java.lang.String appID,
                                      java.lang.String fileName)

This method adds a file link to a given communication.

Parameters:

appID -

fileName -

Returns:

true no success.