Package VASSAL.build.module

Class Chatter

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

VASSAL.build.module.Chatter

All Implemented Interfaces:

DropTargetListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, Buildable, CommandEncoder

Direct Known Subclasses:

PrivateChatter

public class Chatter
extends JPanel
implements CommandEncoder, Buildable, DropTargetListener

The chat window component. Displays text messages and accepts input. Also acts as a CommandEncoder, encoding/decoding commands that display message in the text area

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Chatter.DisplayText	This is a Command object that, when executed, displays a text message in the Chatter's text area

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected JTextArea	conversation
protected JTextPane	conversationPane
protected HTMLDocument	doc
protected DropTarget	dt
protected static final String	GAME_MSG1_COLOR
protected static final String	GAME_MSG2_COLOR
protected static final String	GAME_MSG3_COLOR
protected static final String	GAME_MSG4_COLOR
protected static final String	GAME_MSG5_COLOR
protected Color	gameMsg
protected Color	gameMsg2
protected Color	gameMsg3
protected Color	gameMsg4
protected Color	gameMsg5
protected JTextField	input
protected HTMLEditorKit	kit
protected static final String	MY_CHAT_COLOR
protected Color	myChat
protected Font	myFont
protected boolean	needUpdate
protected static final String	OTHER_CHAT_COLOR
protected Color	otherChat
protected JScrollPane	scroll
protected StyleSheet	style
protected static final String	SYS_MSG_COLOR
protected Color	systemMsg

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
Chatter()

Method Summary

Modifier and Type	Method	Description
void	add(Buildable b)	Adds a child component.
protected void	addStyle(String s, Font f, Color c, String font_weight, int size)	Adds or updates a CSS stylesheet entry.
void	addTo(Buildable b)	Expects to be added to a GameModule.
void	build(Element e)	Build the object from the XML representation of the Buildable
boolean	consoleHook(String s, String style, boolean html_allowed)	A hook for inserting a console class that accepts commands
Command	decode(String s)	Translate a String into a Command
void	dragEnter(DropTargetDragEvent event)
void	dragExit(DropTargetEvent event)
void	dragOver(DropTargetDragEvent event)
void	drop(DropTargetDropEvent dtde)	We put the "drop" in drag-n-drop!
void	dropActionChanged(DropTargetDragEvent event)
String	encode(Command c)	Translate a Command into a String
protected String	formatChat(String text)
static String	getAnonymousUserName()
Element	getBuildElement(Document doc)
protected String	getChatStyle(String s)	Styles a chat message based on the player who sent it.
String	getHandle()	Deprecated, for removal: This API element is subject to removal in a future version. use GlobalOptions.getPlayerId()
JTextField	getInputField()
boolean	isMandatory()	Is this component a reqired component within its parent?
boolean	isUnique()	Does this component need to be unique within it's parent?
void	keyCommand(KeyStroke e)	Classes other than the Chatter itself may forward KeyEvents to the Chatter by using this method
static void	main(String[] args)
protected void	makeStyleSheet(Font f)	Build ourselves a CSS stylesheet from our preference font/color settings.
void	send(String msg)	Displays the message, Also logs and sends to the server a Command that displays this message.
void	send(String msg, String console)	Checks first for an intercepted console command; otherwise displays the message
protected void	setChatterVisible(boolean vis)	Because our Chatters make themselves visible in their constructor, providing a way for an overriding class to "turn this chatter off" is friendlier than What Went Before.
void	setFont(Font f)	Set the Font used by the text area
void	show(String s)	Display a message in the text area.
static void	warning(String msg)	Warning message method -- same as send, but accepts messages from static methods.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.build.Buildable

isMovable

Field Details

conversationPane

protected JTextPane conversationPane

doc

protected HTMLDocument doc

kit

protected HTMLEditorKit kit

style

protected StyleSheet style

input

protected JTextField input

scroll

protected JScrollPane scroll

MY_CHAT_COLOR

protected static final String MY_CHAT_COLOR

See Also:

• Constant Field Values

OTHER_CHAT_COLOR

protected static final String OTHER_CHAT_COLOR

See Also:

• Constant Field Values

GAME_MSG1_COLOR

protected static final String GAME_MSG1_COLOR

See Also:

• Constant Field Values

GAME_MSG2_COLOR

protected static final String GAME_MSG2_COLOR

See Also:

• Constant Field Values

GAME_MSG3_COLOR

protected static final String GAME_MSG3_COLOR

See Also:

• Constant Field Values

GAME_MSG4_COLOR

protected static final String GAME_MSG4_COLOR

See Also:

• Constant Field Values

GAME_MSG5_COLOR

protected static final String GAME_MSG5_COLOR

See Also:

• Constant Field Values

SYS_MSG_COLOR

protected static final String SYS_MSG_COLOR

See Also:

• Constant Field Values

myFont

protected Font myFont

gameMsg

protected Color gameMsg

gameMsg2

protected Color gameMsg2

gameMsg3

protected Color gameMsg3

gameMsg4

protected Color gameMsg4

gameMsg5

protected Color gameMsg5

systemMsg

protected Color systemMsg

myChat

protected Color myChat

otherChat

protected Color otherChat

needUpdate

protected boolean needUpdate

dt

protected DropTarget dt

conversation

protected JTextArea conversation

Constructor Details

Chatter

public Chatter()

Method Details

getAnonymousUserName

public static String getAnonymousUserName()

setChatterVisible

protected void setChatterVisible(boolean vis)

Because our Chatters make themselves visible in their constructor, providing a way for an overriding class to "turn this chatter off" is friendlier than What Went Before.

Parameters:

vis - - whether this chatter should be visible

formatChat

protected String formatChat(String text)

getInputField

public JTextField getInputField()

getChatStyle

protected String getChatStyle(String s)

Styles a chat message based on the player who sent it. Presently just distinguishes a chat message "from me" from a chat message "from anyone else".

To make the player colors easy to override in a custom class (my modules have logic to assign individual player colors -- beyond the scope of the present effort but a perhaps a fun future addition)

Parameters:

s - - chat message from a player

Returns:

- an entry in our CSS style sheet to use for this chat message

consoleHook

public boolean consoleHook(String s,
 String style,
 boolean html_allowed)

A hook for inserting a console class that accepts commands

Parameters:

s - - chat message

style - - current style name (contains information that might be useful)

html_allowed - - flag if html_processing is enabled for this message (allows console to apply security considerations)

Returns:

true - if was accepted as a console command

show

public void show(String s)

Display a message in the text area. Ensures we execute in the EDT

addStyle

protected void addStyle(String s,
 Font f,
 Color c,
 String font_weight,
 int size)

Adds or updates a CSS stylesheet entry. Styles in the color, font type, and font size.

Parameters:

s - Style name

f - Font to use

c - Color for text

font_weight - Bold? Italic?

size - Font size

makeStyleSheet

protected void makeStyleSheet(Font f)

Build ourselves a CSS stylesheet from our preference font/color settings.

Parameters:

f - - Font to use for this stylesheet

setFont

public void setFont(Font f)

Set the Font used by the text area

Overrides:

setFont in class JComponent

build

public void build(Element e)

Description copied from interface: Buildable

Build the object from the XML representation of the Buildable

Specified by:

build in interface Buildable

Parameters:

e - the XML element containing the object data

getBuildElement

public Element getBuildElement(Document doc)

Specified by:

getBuildElement in interface Buildable

Parameters:

doc - XML file

Returns:

an XML element from which this component can be built

addTo

public void addTo(Buildable b)

Expects to be added to a GameModule. Adds itself to the controls window and registers itself as a CommandEncoder

Specified by:

addTo in interface Buildable

Parameters:

b - parent Buildable to add this component to as a subcomponent.

add

public void add(Buildable b)

Description copied from interface: Buildable

Adds a child component. Both this method and Buildable.addTo(VASSAL.build.Buildable) are invoked when adding a child to a parent

Specified by:

add in interface Buildable

Parameters:

b - Child to attach to this buildable as a subcomponent

decode

public Command decode(String s)

Description copied from interface: CommandEncoder

Translate a String into a Command

Specified by:

decode in interface CommandEncoder

encode

public String encode(Command c)

Description copied from interface: CommandEncoder

Translate a Command into a String

Specified by:

encode in interface CommandEncoder

send

public void send(String msg)

Displays the message, Also logs and sends to the server a Command that displays this message.

send

public void send(String msg,
 String console)

Checks first for an intercepted console command; otherwise displays the message

Parameters:

msg - message to display if not a console command

console - potential console command (without any chat livery added to it)

warning

public static void warning(String msg)

Warning message method -- same as send, but accepts messages from static methods. For reporting soft-fail problems in modules.

keyCommand

public void keyCommand(KeyStroke e)

Classes other than the Chatter itself may forward KeyEvents to the Chatter by using this method

main

public static void main(String[] args)

getHandle

@Deprecated(since="2020-08-06",
            forRemoval=true)
public String getHandle()

Deprecated, for removal: This API element is subject to removal in a future version.

use GlobalOptions.getPlayerId()

dragEnter

public void dragEnter(DropTargetDragEvent event)

Specified by:

dragEnter in interface DropTargetListener

dragExit

public void dragExit(DropTargetEvent event)

Specified by:

dragExit in interface DropTargetListener

dragOver

public void dragOver(DropTargetDragEvent event)

Specified by:

dragOver in interface DropTargetListener

dropActionChanged

public void dropActionChanged(DropTargetDragEvent event)

Specified by:

dropActionChanged in interface DropTargetListener

drop

public void drop(DropTargetDropEvent dtde)

We put the "drop" in drag-n-drop!

Specified by:

drop in interface DropTargetListener

Parameters:

dtde - DropTargetDragEvent

isMandatory

public boolean isMandatory()

Description copied from interface: Buildable

Is this component a reqired component within its parent?

Specified by:

isMandatory in interface Buildable

Returns:

true if component is mandatory

isUnique

public boolean isUnique()

Description copied from interface: Buildable

Does this component need to be unique within it's parent?

Specified by:

isUnique in interface Buildable

Returns: