Class PrivateChatter

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

VASSAL.build.module.Chatter

VASSAL.chat.PrivateChatter

All Implemented Interfaces:

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

public class PrivateChatter
extends Chatter

A window for private messages between the user and another player;

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class Chatter

Chatter.DisplayText

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 JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

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

Field Summary

Fields inherited from class Chatter

conversation, conversationPane, doc, dt, GAME_MSG1_COLOR, GAME_MSG2_COLOR, GAME_MSG3_COLOR, GAME_MSG4_COLOR, GAME_MSG5_COLOR, gameMsg, gameMsg2, gameMsg3, gameMsg4, gameMsg5, input, kit, MY_CHAT_COLOR, myChat, myFont, needUpdate, OTHER_CHAT_COLOR, otherChat, scroll, style, SYS_MSG_COLOR, systemMsg

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 JComponent

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

Fields inherited from class Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
PrivateChatter(Player other, ChatServerConnection client)

Method Summary

Modifier and Type	Method	Description
ServerConnection	getClient()
Player	getPlayer()
void	send(String msg)	Displays the message, Also logs and sends to the server a Command that displays this message.

Methods inherited from class Chatter

add, addStyle, addTo, build, consoleHook, decode, dragEnter, dragExit, dragOver, drop, dropActionChanged, encode, formatChat, getAnonymousUserName, getBuildElement, getChatStyle, getHandle, getInputField, isMandatory, isUnique, keyCommand, main, makeStyleSheet, send, setChatterVisible, setFont, show, warning

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, 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 JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class 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 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 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 Object

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

Methods inherited from interface Buildable

isMovable

Modifier and Type	Method	Description
default boolean	isMovable()	Is this component allowed to be moved around the Configure Tree?

Constructor Details

PrivateChatter

public PrivateChatter(Player other,
 ChatServerConnection client)

Method Details

send

public void send(String msg)

Description copied from class: Chatter

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

Overrides:

send in class Chatter

getPlayer

public Player getPlayer()

getClient

public ServerConnection getClient()