com.threerings.chat

Class ChatOverlay

java.lang.Object

com.threerings.chat.ChatOverlay

All Implemented Interfaces:

ChatDisplay

Direct Known Subclasses:

SubtitleChatOverlay

public abstract class ChatOverlay
extends Object
implements ChatDisplay

An abstract class that represents a chat display that can be overlayed upon another component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChatOverlay.InfoProvider An interface for providing information about what is under the overlay.

Method Summary

Modifier and Type	Method and Description
void	added(VirtualMediaPanel target) Indicates that the target component was added to the widget hier.
VirtualMediaPanel	getTarget() Returns the media panel on which this chat overlay is operating.
abstract void	layout() Layout the chat overlay inside the previously configured target component.
void	newPlaceEntered(ChatOverlay.InfoProvider provider) Callback from the target that the place has changed and we are to now talk to the new info provider.
void	placeExited() A callback indicating that we've left the place and should stop talking to a particular infoprovider.
void	removed() Indicates that the target component was removed from the widget hier.
void	setDimmed(boolean dimmed) Set the dimmed mode of the currently displaying glyphs.
void	setVisible(boolean visible) Causes the chat overlay to make itself visible or invisible.
void	speakerDeparted(Name speaker) Should be called when a speaker departs the chat area to allow the overlay to clean up.
void	viewDidScroll(int dx, int dy) Called if our containing media panel scrolled its view.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.threerings.crowd.chat.client.ChatDisplay

clear, displayMessage

Method Detail

setVisible

public void setVisible(boolean visible)

Causes the chat overlay to make itself visible or invisible.

setDimmed

public void setDimmed(boolean dimmed)

Set the dimmed mode of the currently displaying glyphs.

added

public void added(VirtualMediaPanel target)

Indicates that the target component was added to the widget hier. Should be called when we wish to start displaying chat.

layout

public abstract void layout()

Layout the chat overlay inside the previously configured target component. Should be called if our component changes size.

removed

public void removed()

Indicates that the target component was removed from the widget hier. Should be called when we no longer wish to paint chat.

newPlaceEntered

public void newPlaceEntered(ChatOverlay.InfoProvider provider)

Callback from the target that the place has changed and we are to now talk to the new info provider.

placeExited

public void placeExited()

A callback indicating that we've left the place and should stop talking to a particular infoprovider.

getTarget

public VirtualMediaPanel getTarget()

Returns the media panel on which this chat overlay is operating.

speakerDeparted

public void speakerDeparted(Name speaker)

Should be called when a speaker departs the chat area to allow the overlay to clean up.

viewDidScroll

public void viewDidScroll(int dx,
                          int dy)

Called if our containing media panel scrolled its view.