net.java.sip.communicator.impl.gui.main.chat.conference
Class ChatRoomWrapper

java.lang.Object
  net.java.sip.communicator.impl.gui.main.chat.conference.ChatRoomWrapper

public class ChatRoomWrapper
extends Object

The ChatRoomWrapper is the representation of the ChatRoom in the GUI. It stores the information for the chat room even when the corresponding protocol provider is not connected.

Author:

Yana Stamcheva, Damian Minkov

Constructor Summary

ChatRoomWrapper(ChatRoomProviderWrapper parentProvider, ChatRoom chatRoom)
Creates a ChatRoomWrapper by specifying the corresponding chat room.

ChatRoomWrapper(ChatRoomProviderWrapper parentProvider, String chatRoomID, String chatRoomName)
Creates a ChatRoomWrapper by specifying the protocol provider, the identifier and the name of the chat room.

Method Summary

ChatRoom	getChatRoom() Returns the ChatRoom that this wrapper represents.
String	getChatRoomID() Returns the identifier of the chat room.
String	getChatRoomName() Returns the chat room name.
ChatRoomProviderWrapper	getParentProvider() Returns the parent protocol provider.
boolean	isAutojoin() Is room set to auto join on start-up.
boolean	isPersistent() Returns true if the chat room is persistent, otherwise - returns false.
void	setAutoJoin(boolean value) Changes auto join value in configuration service.
void	setChatRoom(ChatRoom chatRoom) Sets the ChatRoom that this wrapper represents.
void	setPersistent(boolean value) Change persistence of this room.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChatRoomWrapper

public ChatRoomWrapper(ChatRoomProviderWrapper parentProvider,
                       String chatRoomID,
                       String chatRoomName)

Creates a ChatRoomWrapper by specifying the protocol provider, the identifier and the name of the chat room.

Parameters:

parentProvider - the protocol provider to which the corresponding chat room belongs

chatRoomID - the identifier of the corresponding chat room

chatRoomName - the name of the corresponding chat room

ChatRoomWrapper

public ChatRoomWrapper(ChatRoomProviderWrapper parentProvider,
                       ChatRoom chatRoom)

Creates a ChatRoomWrapper by specifying the corresponding chat room.

Parameters:

parentProvider - the protocol provider to which the corresponding chat room belongs

chatRoom - the chat room to which this wrapper corresponds.

Method Detail

getChatRoom

public ChatRoom getChatRoom()

Returns the ChatRoom that this wrapper represents.

Returns:

the ChatRoom that this wrapper represents.

setChatRoom

public void setChatRoom(ChatRoom chatRoom)

Sets the ChatRoom that this wrapper represents.

Parameters:

chatRoom - the chat room

getChatRoomName

public String getChatRoomName()

Returns the chat room name.

Returns:

the chat room name

getChatRoomID

public String getChatRoomID()

Returns the identifier of the chat room.

Returns:

the identifier of the chat room

getParentProvider

public ChatRoomProviderWrapper getParentProvider()

Returns the parent protocol provider.

Returns:

the parent protocol provider

isPersistent

public boolean isPersistent()

Returns true if the chat room is persistent, otherwise - returns false.

Returns:

true if the chat room is persistent, otherwise - returns false.

setPersistent

public void setPersistent(boolean value)

Change persistence of this room.

Parameters:

value - set persistent state.

isAutojoin

public boolean isAutojoin()

Is room set to auto join on start-up.

Returns:

is auto joining enabled.

setAutoJoin

public void setAutoJoin(boolean value)

Changes auto join value in configuration service.

Parameters:

value - change of auto join property.