org.starhope.rahab.ui
Class SpyUI

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.starhope.rahab.ui.SpyUI

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class SpyUI
extends JPanel

WRITEME: Document this type. twheys@gmail.com Dec 29, 2009

Author:

Tim Heys

See Also:

Serialized Form

Nested Class Summary

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

private static String	BLACKLIST_TEXT_STYLE
private String	currentZone
private DateFormat	dateFormatter WRITEME: Document this field.
private static String	ERROR_TEXT_STYLE
private StyledDocument	gameMailStyledDocument
private JTextPane	gameMailTextPane
private static String	GRAY_TEXT_STYLE
private Vector<String>	history
private int	historyTracker
private DefaultMutableTreeNode	houseListRoot
protected JTextField	inputTextArea
(package private) Logger	logger
private static int	MAX_HISTORY_TOKENS WRITEME: Document this field.
private MessageCallBack	messageCallBack
private static String	MOD_DISPLAY_TEXT_STYLE
private static String	MODERATOR_NAME_STYLE
private DefaultMutableTreeNode	modListRoot
private static String	NORMAL_TEXT_STYLE
private static String	PUBLIC_USER_NAME_STYLE
private static String	REDLIST_TEXT_STYLE
protected RightClickContextMenu	rightClickContext
private JTree	roomList
private DefaultMutableTreeNode	roomListRoot
private DefaultMutableTreeNode	root
private static long	serialVersionUID WRITEME: Document this field.
private static String	SYSTEM_NAME_STYLE
private static String	SYSTEM_SPEAKER WRITEME: Document this field.
private MouseListener	USER_LIST_MOUSE_LISTENER WRITEME: Document this field.
private JList	userList
private Vector<String>	userListVector
private StyledDocument	zoneChatStyledDocument
private JTextPane	zoneChatTextPane

Fields inherited from class javax.swing.JComponent

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

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

SpyUI(MessageCallBack actionCallBack, String zoneName)
twheys@gmail.com Dec 29, 2009

Method Summary

private void	addLeafToTree(String leafName, String branchName, DefaultMutableTreeNode rootTree) twheys@gmail.com Dec 30, 2009
protected void	addStylesToDocument(StyledDocument document) twheys@gmail.com Dec 30, 2009
void	addToHistory(String message) twheys@gmail.com Dec 31, 2009
void	addUserToHouse(String userName, String room) twheys@gmail.com Dec 30, 2009
void	addUserToMOD(String userName) twheys@gmail.com Dec 31, 2009
void	addUserToRoom(String userName, String room) twheys@gmail.com Dec 30, 2009
void	addUserToUserList(String userName) twheys@gmail.com Dec 30, 2009
private DefaultMutableTreeNode	getBranchByNameFromRoot(String room, DefaultMutableTreeNode rootTree) twheys@gmail.com Dec 30, 2009
private JPanel	getInputField() twheys@gmail.com Dec 29, 2009
private String	getLogo() twheys@gmail.com Jan 5, 2010
protected String	getNextTokenInHistory(boolean olderToken) twheys@gmail.com Dec 31, 2009
private JScrollPane	getRoomListTab() twheys@gmail.com Dec 30, 2009
private static JScrollPane	getScrollForTextPane(Component textPane) twheys@gmail.com Jan 5, 2010
private JTabbedPane	getTabbedPane() twheys@gmail.com Jan 5, 2010
private DefaultMutableTreeNode	getTreeBranchByUserObject(String room, DefaultMutableTreeNode leaf) twheys@gmail.com Dec 30, 2009
protected JList	getUserList()
private JTabbedPane	getUserLists() twheys@gmail.com Dec 29, 2009
private JScrollPane	getUserListTab() twheys@gmail.com Dec 30, 2009
void	initListOfUsers(Vector<String> newUserListVector) twheys@gmail.com Dec 30, 2009
private void	refreshJTree(JTree jTree) twheys@gmail.com Jan 5, 2010
private void	refreshRoomList() twheys@gmail.com Jan 5, 2010
void	removeLeafFromTree(String userName, DefaultMutableTreeNode rootTree) twheys@gmail.com Dec 30, 2009
void	removeUserFromRoomList(String userName) twheys@gmail.com Dec 30, 2009
private void	scrollZoneOutputToBottom() twheys@gmail.com Dec 30, 2009
protected void	sendPublicMessage() twheys@gmail.com Dec 30, 2009
void	setTreeRoot(String zone) twheys@gmail.com Dec 30, 2009
void	setZoneChatAutoScrolls(boolean autoscrolls) twheys@gmail.com Feb 8, 2010
void	showBlackListMessage(String speaker, String room, String message) twheys@gmail.com Mar 10, 2010
void	showDialog(String title, String label, String message) twheys@gmail.com Dec 30, 2009
void	showErrorMessage(String message) twheys@gmail.com Dec 30, 2009
private void	showMessage(String speaker, String room, String message, Style userNameStyle, Style displayTextStyle) twheys@gmail.com Dec 29, 2009
void	showModMessage(String speaker, String message) twheys@gmail.com Mar 10, 2010
void	showRedListMessage(String speaker, String room, String message) twheys@gmail.com Mar 10, 2010
void	showReport(String reportingUser, String reportedUser, String room) twheys@gmail.com Jan 5, 2010
void	showSaidMessage(String speaker, String room, String message) twheys@gmail.com Mar 10, 2010
void	showSystemMessage(String systemMessage) twheys@gmail.com Dec 29, 2009

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, setFont, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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

Field Detail

BLACKLIST_TEXT_STYLE

private static final String BLACKLIST_TEXT_STYLE

See Also:

Constant Field Values

ERROR_TEXT_STYLE

private static final String ERROR_TEXT_STYLE

See Also:

Constant Field Values

GRAY_TEXT_STYLE

private static final String GRAY_TEXT_STYLE

See Also:

Constant Field Values

MAX_HISTORY_TOKENS

private static final int MAX_HISTORY_TOKENS

WRITEME: Document this field. twheys@gmail.com Dec 31, 2009

See Also:

Constant Field Values

MOD_DISPLAY_TEXT_STYLE

private static final String MOD_DISPLAY_TEXT_STYLE

See Also:

Constant Field Values

MODERATOR_NAME_STYLE

private static final String MODERATOR_NAME_STYLE

See Also:

Constant Field Values

NORMAL_TEXT_STYLE

private static final String NORMAL_TEXT_STYLE

See Also:

Constant Field Values

PUBLIC_USER_NAME_STYLE

private static final String PUBLIC_USER_NAME_STYLE

See Also:

Constant Field Values

REDLIST_TEXT_STYLE

private static final String REDLIST_TEXT_STYLE

See Also:

Constant Field Values

serialVersionUID

private static final long serialVersionUID

WRITEME: Document this field. twheys@gmail.com Dec 29, 2009

See Also:

Constant Field Values

SYSTEM_NAME_STYLE

private static final String SYSTEM_NAME_STYLE

See Also:

Constant Field Values

SYSTEM_SPEAKER

private static final String SYSTEM_SPEAKER

WRITEME: Document this field. twheys@gmail.com Dec 30, 2009

See Also:

Constant Field Values

currentZone

private String currentZone

dateFormatter

private final DateFormat dateFormatter

WRITEME: Document this field. twheys@gmail.com Jan 5, 2010

gameMailStyledDocument

private final StyledDocument gameMailStyledDocument

gameMailTextPane

private final JTextPane gameMailTextPane

history

private final Vector<String> history

historyTracker

private int historyTracker

houseListRoot

private DefaultMutableTreeNode houseListRoot

inputTextArea

protected JTextField inputTextArea

logger

Logger logger

messageCallBack

private final MessageCallBack messageCallBack

modListRoot

private DefaultMutableTreeNode modListRoot

rightClickContext

protected final RightClickContextMenu rightClickContext

roomList

private JTree roomList

roomListRoot

private DefaultMutableTreeNode roomListRoot

root

private DefaultMutableTreeNode root

USER_LIST_MOUSE_LISTENER

private final MouseListener USER_LIST_MOUSE_LISTENER

WRITEME: Document this field. twheys@gmail.com Dec 31, 2009

userList

private JList userList

userListVector

private Vector<String> userListVector

zoneChatStyledDocument

private final StyledDocument zoneChatStyledDocument

zoneChatTextPane

private final JTextPane zoneChatTextPane

Constructor Detail

SpyUI

public SpyUI(MessageCallBack actionCallBack,
             String zoneName)

 twheys@gmail.com Dec 29, 2009
 

A SpyUI WRITEME...

Parameters:

actionCallBack - WRITEME

zoneName - WRITEME

Method Detail

getScrollForTextPane

private static JScrollPane getScrollForTextPane(Component textPane)

 twheys@gmail.com Jan 5, 2010
 

TO getScrollForTextPane WRITEME...

Parameters:

textPane - WRITEME

Returns:

WRITEME

addLeafToTree

private void addLeafToTree(String leafName,
                           String branchName,
                           DefaultMutableTreeNode rootTree)

 twheys@gmail.com Dec 30, 2009
 

TO addLeafToTree WRITEME...

Parameters:

leafName - WRITEME

branchName - WRITEME

rootTree - WRITEME

addStylesToDocument

protected void addStylesToDocument(StyledDocument document)

 twheys@gmail.com Dec 30, 2009
 

TO addStylesToDocument WRITEME...

Parameters:

document - WRITEME

addToHistory

public void addToHistory(String message)

 twheys@gmail.com Dec 31, 2009
 

TO addToHistory WRITEME...

Parameters:

message - WRITEME

addUserToHouse

public void addUserToHouse(String userName,
                           String room)

 twheys@gmail.com Dec 30, 2009
 

TO addUserToRoom WRITEME...

Parameters:

userName - WRITEME

room - WRITEME

addUserToMOD

public void addUserToMOD(String userName)

 twheys@gmail.com Dec 31, 2009
 

TO addUserToMOD WRITEME...

Parameters:

userName - WRITEME

addUserToRoom

public void addUserToRoom(String userName,
                          String room)

 twheys@gmail.com Dec 30, 2009
 

TO addUserToRoom WRITEME...

Parameters:

userName - WRITEME

room - WRITEME

addUserToUserList

public void addUserToUserList(String userName)

 twheys@gmail.com Dec 30, 2009
 

TO addUserToUserList WRITEME...

Parameters:

userName - WRITEME

getBranchByNameFromRoot

private DefaultMutableTreeNode getBranchByNameFromRoot(String room,
                                                       DefaultMutableTreeNode rootTree)
                                                throws Exception

 twheys@gmail.com Dec 30, 2009
 

TO getRoomBranchByRoomName WRITEME...

Parameters:

room - WRITEME

rootTree - WRITEME

Returns:

WRITEME

Throws:

Exception - WRITEME

getInputField

private JPanel getInputField()

 twheys@gmail.com Dec 29, 2009
 

TO getInputField WRITEME...

Returns:

a constructed input field

getLogo

private String getLogo()

 twheys@gmail.com Jan 5, 2010
 

TO getLogo WRITEME...

Returns:

WRITEME

getNextTokenInHistory

protected String getNextTokenInHistory(boolean olderToken)

 twheys@gmail.com Dec 31, 2009
 

TO getNextTokenInHistory WRITEME...

Parameters:

olderToken - WRITEME

Returns:

WRITEME

getRoomListTab

private JScrollPane getRoomListTab()

 twheys@gmail.com Dec 30, 2009
 

TO getRoomListTab WRITEME...

Returns:

WRITEME

getTabbedPane

private JTabbedPane getTabbedPane()

 twheys@gmail.com Jan 5, 2010
 

TO getChatTabbedPane WRITEME...

Returns:

WRITEME

getTreeBranchByUserObject

private DefaultMutableTreeNode getTreeBranchByUserObject(String room,
                                                         DefaultMutableTreeNode leaf)
                                                  throws Exception

 twheys@gmail.com Dec 30, 2009
 

TO getRoomBranchByRoomName WRITEME...

Parameters:

room - WRITEME

leaf - WRITEME

Returns:

WRITEME

Throws:

Exception - WRITEME

getUserList

protected JList getUserList()

Returns:

the userList

getUserLists

private JTabbedPane getUserLists()

 twheys@gmail.com Dec 29, 2009
 

TO getUserLists WRITEME...

Returns:

a constructed JTabbedPane to display a list of users in alphabetical order and sorted by what room they're in.

getUserListTab

private JScrollPane getUserListTab()

 twheys@gmail.com Dec 30, 2009
 

TO getUserListTab WRITEME...

Returns:

WRITEME

initListOfUsers

public void initListOfUsers(Vector<String> newUserListVector)

 twheys@gmail.com Dec 30, 2009
 

TO initListOfUsers WRITEME...

Parameters:

newUserListVector - WRITEME

refreshJTree

private void refreshJTree(JTree jTree)

 twheys@gmail.com Jan 5, 2010
 

TO refreshRoomList WRITEME...

Parameters:

jTree - WRITEME

refreshRoomList

private void refreshRoomList()

 twheys@gmail.com Jan 5, 2010
 

TO refreshRoomList WRITEME...

removeLeafFromTree

public void removeLeafFromTree(String userName,
                               DefaultMutableTreeNode rootTree)

 twheys@gmail.com Dec 30, 2009
 

TO removeUserFromRoomList WRITEME...

Parameters:

userName - WRITEME WRITEME

rootTree - WRITEME WRITEME

removeUserFromRoomList

public void removeUserFromRoomList(String userName)

 twheys@gmail.com Dec 30, 2009
 

TO removeUserFromRoomList WRITEME...

Parameters:

userName - WRITEME

scrollZoneOutputToBottom

private void scrollZoneOutputToBottom()

 twheys@gmail.com Dec 30, 2009
 

TO scrollOutputToBottom WRITEME...

sendPublicMessage

protected void sendPublicMessage()

 twheys@gmail.com Dec 30, 2009
 

TO sendPublicMessage WRITEME...

setTreeRoot

public void setTreeRoot(String zone)

 twheys@gmail.com Dec 30, 2009
 

TO setTreeRoot WRITEME...

Parameters:

zone - WRITEME

setZoneChatAutoScrolls

public void setZoneChatAutoScrolls(boolean autoscrolls)

 twheys@gmail.com Feb 8, 2010
 

TO setZoneChatAutoScrolls set the autoscrolls on the zoneChatTextPane

Parameters:

autoscrolls - WRITEME

showBlackListMessage

public void showBlackListMessage(String speaker,
                                 String room,
                                 String message)

 twheys@gmail.com Mar 10, 2010
 

TO showSaidMessage WRITEME...

Parameters:

speaker - WRITEME

room - WRITEME

message - WRITEME

showDialog

public void showDialog(String title,
                       String label,
                       String message)

 twheys@gmail.com Dec 30, 2009
 

TO showPopupDialog WRITEME...

Parameters:

title - WRITEME

label - WRITEME

message - WRITEME

showErrorMessage

public void showErrorMessage(String message)

 twheys@gmail.com Dec 30, 2009
 

TO showErrorMessage WRITEME...

Parameters:

message - WRITEME

showMessage

private void showMessage(String speaker,
                         String room,
                         String message,
                         Style userNameStyle,
                         Style displayTextStyle)

 twheys@gmail.com Dec 29, 2009
 

TO showMessage WRITEME...

Parameters:

speaker - WRITEME

room - WRITEME

message - WRITEME

userNameStyle - WRITEME

displayTextStyle - WRITEME

showModMessage

public void showModMessage(String speaker,
                           String message)

 twheys@gmail.com Mar 10, 2010
 

TO showSaidMessage WRITEME...

Parameters:

speaker - WRITEME

message - WRITEME

showRedListMessage

public void showRedListMessage(String speaker,
                               String room,
                               String message)

 twheys@gmail.com Mar 10, 2010
 

TO showSaidMessage WRITEME...

Parameters:

speaker - WRITEME

room - WRITEME

message - WRITEME

showReport

public void showReport(String reportingUser,
                       String reportedUser,
                       String room)

 twheys@gmail.com Jan 5, 2010
 

TO showReport WRITEME...

Parameters:

reportingUser - WRITEME

reportedUser - WRITEME

room - WRITEME

showSaidMessage

public void showSaidMessage(String speaker,
                            String room,
                            String message)

 twheys@gmail.com Mar 10, 2010
 

TO showSaidMessage WRITEME...

Parameters:

speaker - WRITEME

room - WRITEME

message - WRITEME

showSystemMessage

public void showSystemMessage(String systemMessage)

 twheys@gmail.com Dec 29, 2009
 

TO showMessage WRITEME...

Parameters:

systemMessage - WRITEME