org.eclipse.ecf.presence.ui.chatroom
Class ChatRoomManagerUI

java.lang.Object
  extended by org.eclipse.ecf.presence.ui.chatroom.ChatRoomManagerUI
All Implemented Interfaces:
IChatRoomCommandListener

public class ChatRoomManagerUI
extends java.lang.Object
implements IChatRoomCommandListener

Chat room manager user interface.


Field Summary
protected  java.lang.String[] channels
           
protected  ChatRoomManagerView chatroomview
           
protected  IContainer container
           
protected  IExceptionHandler exceptionHandler
           
protected  IChatRoomManager manager
           
static java.lang.String ROOM_DELIMITER
           
protected  ID targetID
           
 
Constructor Summary
ChatRoomManagerUI(IContainer container, IChatRoomManager manager)
           
ChatRoomManagerUI(IContainer container, IChatRoomManager manager, IExceptionHandler exceptionHandler)
           
 
Method Summary
protected  IChatRoomViewCloseListener createChatRoomViewCloseListener()
           
protected  ChatRoomManagerView getChatRoomManagerView()
           
protected  IMessageRenderer getDefaultMessageRenderer()
           
protected  java.lang.String getPasswordForChatRoomConnect(IChatRoomInfo info)
           
protected  java.lang.String[] getRoomsForTarget()
           
protected  java.lang.String getSecondaryViewID(ID id)
           
 ID getTargetID()
           
 java.lang.String handleCommand(IChatRoomContainer chatRoomContainer, java.lang.String inputLine)
          Detect and handle input commands.
 boolean isContainerConnected()
           
protected  java.lang.String modifyRoomNameForTarget(java.lang.String roomName)
           
 void showForTarget(ID target)
          Show a chat room manager UI for given target.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ROOM_DELIMITER

public static final java.lang.String ROOM_DELIMITER
See Also:
Constant Field Values

container

protected IContainer container

manager

protected IChatRoomManager manager

exceptionHandler

protected IExceptionHandler exceptionHandler

chatroomview

protected ChatRoomManagerView chatroomview

targetID

protected ID targetID

channels

protected java.lang.String[] channels
Constructor Detail

ChatRoomManagerUI

public ChatRoomManagerUI(IContainer container,
                         IChatRoomManager manager)

ChatRoomManagerUI

public ChatRoomManagerUI(IContainer container,
                         IChatRoomManager manager,
                         IExceptionHandler exceptionHandler)
Method Detail

getTargetID

public ID getTargetID()

handleCommand

public java.lang.String handleCommand(IChatRoomContainer chatRoomContainer,
                                      java.lang.String inputLine)
Description copied from interface: IChatRoomCommandListener
Detect and handle input commands. If this handler successfully handles the line as a command and does not expect the line to be passed on as chat input, it should return null. If it does not process the line as a command, and the inputLine should be sent along as chat, it should return a non-null String.

Specified by:
handleCommand in interface IChatRoomCommandListener
Parameters:
chatRoomContainer - the IChatRoomContainer instance that is to receive the input line. If null then the input line is intended for the IChatRoomManager itself.
inputLine - the input line holding the prospective command.
Returns:
null if the command has been processed and should not be sent along as chat. Non-null if the inputLine should be forwarded on as chat.

createChatRoomViewCloseListener

protected IChatRoomViewCloseListener createChatRoomViewCloseListener()

getDefaultMessageRenderer

protected IMessageRenderer getDefaultMessageRenderer()

getPasswordForChatRoomConnect

protected java.lang.String getPasswordForChatRoomConnect(IChatRoomInfo info)

showForTarget

public void showForTarget(ID target)
Show a chat room manager UI for given target. If a UI already exists that is connected to the given target, then it will be raised. and isContainerConnected connected to the given target then this will show the view associated with this target, and return true. The caller then should not connect the container, as there is already a container connected to the given target. If we are not already connected, then this method will return false, indicating that the caller should connect the new container to the given target ID.

Parameters:
target -

isContainerConnected

public boolean isContainerConnected()

getSecondaryViewID

protected java.lang.String getSecondaryViewID(ID id)

getChatRoomManagerView

protected ChatRoomManagerView getChatRoomManagerView()
                                              throws org.eclipse.ui.PartInitException
Throws:
org.eclipse.ui.PartInitException

modifyRoomNameForTarget

protected java.lang.String modifyRoomNameForTarget(java.lang.String roomName)

getRoomsForTarget

protected java.lang.String[] getRoomsForTarget()