Package de.lessvoid.nifty.controls.chatcontrol

Class ChatControl

java.lang.Object

de.lessvoid.nifty.controls.AbstractController

de.lessvoid.nifty.controls.chatcontrol.ChatControl

All Implemented Interfaces:

Chat, Controller, NiftyControl, KeyInputHandler

Deprecated.

@Deprecated
public class ChatControl
extends AbstractController
implements Chat, KeyInputHandler

This is the main controller for the chat control.

Version:

0.1

Author:

Mark

Constructor Summary

Constructors

Constructor	Description
ChatControl()	Deprecated. Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addPlayer(java.lang.String playerName, NiftyImage playerIcon)	Deprecated. This method is called when a new player enters the room.
void	addPlayer(java.lang.String playerName, NiftyImage playerIcon, java.lang.String style)	Deprecated. This method is called when a new player enters the room.
void	bind(Nifty niftyParam, Screen screenParam, Element newElement, Parameters properties)	Deprecated.
java.util.List<ChatEntryModelClass>	getLines()	Deprecated. This method returns all the chatlines in the chat.
java.util.List<ChatEntryModelClass>	getPlayers()	Deprecated. This method returns the current list of players in the chat.
boolean	inputEvent(NiftyInputEvent inputEvent)	Deprecated.
boolean	keyEvent(NiftyInputEvent inputEvent)	Deprecated.
void	onFocus(boolean arg0)	Deprecated.
void	onStartScreen()	Deprecated.
void	receivedChatLine(java.lang.String text, NiftyImage icon)	Deprecated. This method is called when a chat line is received which should be displayed in the chat control.
void	receivedChatLine(java.lang.String text, NiftyImage icon, java.lang.String style)	Deprecated. This method is called when a chat line is received which should be displayed in the chat control.
void	removePlayer(java.lang.String playerName)	Deprecated. This method is called when a player leaves the rome and needs to be removed from the list.
void	sendText()	Deprecated. This method is called when the player either presses the send button or the Return key.
void	update()	Deprecated. Updates the lists to reflect any changes made to them, outside of the addPlayer, removePlayer and

Methods inherited from class de.lessvoid.nifty.controls.AbstractController

bind, disable, enable, getElement, getHeight, getId, getStyle, getWidth, hasFocus, init, isBound, isEnabled, layoutCallback, onEndScreen, setEnabled, setFocus, setFocusable, setHeight, setId, setStyle, setWidth

Methods inherited from interface de.lessvoid.nifty.controls.NiftyControl

disable, enable, getElement, getHeight, getId, getStyle, getWidth, hasFocus, isBound, isEnabled, layoutCallback, setEnabled, setFocus, setFocusable, setHeight, setId, setStyle, setWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

ChatControl

public ChatControl()

Deprecated.

Default constructor.

Method Detail

bind

public final void bind(@Nonnull
                       Nifty niftyParam,
                       @Nonnull
                       Screen screenParam,
                       @Nonnull
                       Element newElement,
                       @Nonnull
                       Parameters properties)

Deprecated.

Specified by:

bind in interface Controller

onFocus

public void onFocus(boolean arg0)

Deprecated.

Specified by:

onFocus in interface Controller

Overrides:

onFocus in class AbstractController

onStartScreen

public final void onStartScreen()

Deprecated.

Specified by:

onStartScreen in interface Controller

receivedChatLine

public final void receivedChatLine(@Nonnull
                                   java.lang.String text,
                                   @Nullable
                                   NiftyImage icon)

Deprecated.

Description copied from interface: Chat

This method is called when a chat line is received which should be displayed in the chat control.

Specified by:

receivedChatLine in interface Chat

Parameters:

text - The text to display.

icon - Optionally, an icon can be supplied which is then displayed at the start of the chat line.

receivedChatLine

public void receivedChatLine(@Nonnull
                             java.lang.String text,
                             @Nullable
                             NiftyImage icon,
                             @Nullable
                             java.lang.String style)

Deprecated.

Description copied from interface: Chat

This method is called when a chat line is received which should be displayed in the chat control. This method has one extra parameter. This parameter allows for a custom style to be set per chat line.

Specified by:

receivedChatLine in interface Chat

Parameters:

text - The text to display.

icon - Optionally, an icon can be supplied which is then displayed at the start of the chat line.

style - The custom style for this particular chatline.

addPlayer

public final void addPlayer(@Nonnull
                            java.lang.String playerName,
                            @Nullable
                            NiftyImage playerIcon)

Deprecated.

Description copied from interface: Chat

This method is called when a new player enters the room. This adds that player to the list of players already in the room. If more then one player needs to be added, this method will have to be called multiple times.

Specified by:

addPlayer in interface Chat

Parameters:

playerName - The player to add.

playerIcon - Optionally, an icon can be supplied which is then displayed in front of the player name.

addPlayer

public void addPlayer(@Nonnull
                      java.lang.String playerName,
                      @Nullable
                      NiftyImage playerIcon,
                      @Nullable
                      java.lang.String style)

Deprecated.

Description copied from interface: Chat

This method is called when a new player enters the room. This adds that player to the list of players already in the room. If more then one player needs to be added, this method will have to be called multiple times. This method has an additional parameter which allows for the setting of a custom style per entry.

Specified by:

addPlayer in interface Chat

Parameters:

playerName - The player to add.

playerIcon - Optionally, an icon can be supplied which is then displayed in front of the player name.

style - The custom style for this player. This style is depicted in the player list.

removePlayer

public final void removePlayer(@Nonnull
                               java.lang.String playerName)

Deprecated.

Description copied from interface: Chat

This method is called when a player leaves the rome and needs to be removed from the list.

Specified by:

removePlayer in interface Chat

Parameters:

playerName - The player name to remove.

getPlayers

@Nonnull
public java.util.List<ChatEntryModelClass> getPlayers()

Deprecated.

Description copied from interface: Chat

This method returns the current list of players in the chat.

Specified by:

getPlayers in interface Chat

Returns:

The current list of players.

getLines

@Nonnull
public java.util.List<ChatEntryModelClass> getLines()

Deprecated.

Description copied from interface: Chat

This method returns all the chatlines in the chat.

Specified by:

getLines in interface Chat

Returns:

The current list of chatlines.

update

public void update()

Deprecated.

Description copied from interface: Chat

Updates the lists to reflect any changes made to them, outside of the addPlayer, removePlayer and

Specified by:

update in interface Chat

sendText

public final void sendText()

Deprecated.

This method is called when the player either presses the send button or the Return key.

keyEvent

public boolean keyEvent(@Nonnull
                        NiftyInputEvent inputEvent)

Deprecated.

Specified by:

keyEvent in interface KeyInputHandler

inputEvent

public boolean inputEvent(@Nonnull
                          NiftyInputEvent inputEvent)

Deprecated.

Specified by:

inputEvent in interface Controller