/******************************************************************************

  * ChatOutput.java - Component that handles the Chat Putput.

  * $Id$

  * 

  * BuckoFIBS - Backgammon by BuckoSoft

  * Copyright(c) 2009,2010 - Dick Balaska - BuckoSoft, Corp.

  * 

  * $Log$

  * Revision 1.4  2011/06/22 06:02:10  dick

  * Support the new ChatTabs.

  *

  * Revision 1.3  2010/03/03 13:12:22  inim

  * Replaced (c) sign in comment mangled by CVS default encoding back to UTF-8

  *

  * Revision 1.2  2010/03/03 12:19:49  inim

  * Moved source to UTF8 encoding from CP1252 encoding. To this end all source files' (c) message was updated to "Copyright© 2009,2010 - Dick Balaska - BuckoSoft, Corp.". This replaces the (c) sign to UTF8, and adds the new year 2010.

  *

  * Revision 1.1  2010/02/04 05:57:53  inim

  * Mavenized project folder layout

  *

  * Revision 1.2  2009/02/14 15:37:51  dick

  * BuckoFIBS is released under the GNU license.

  *

  * Revision 1.1  2009/01/28 19:38:39  dick

  * package com.buckosoft.fibs.gui.chatWindow becomes com.buckosoft.fibs.BuckoFIBS.gui.chatWindow.

  *

  * Revision 1.2  2008/12/11 08:49:57  dick

  * Inbound chat is being written to the window.

  *

  * Revision 1.1  2008/10/08 23:09:41  dick

  * Define the chat subsystem.

  */

 /* 

  * This program is free software: you can redistribute it and/or modify

  * it under the terms of the GNU General Public License as published by

  * the Free Software Foundation, either version 3 of the License, or

  * (at your option) any later version.

  *

  * This program is distributed in the hope that it will be useful,

  * but WITHOUT ANY WARRANTY; without even the implied warranty of

  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  * GNU General Public License for more details.

  *

  * You should have received a copy of the GNU General Public License

  * along with this program.  If not, see <http://www.gnu.org/licenses/>.

  *

  * The Original Code is BuckoFIBS, <http://www.buckosoft.com/BuckoFIBS/>.

  * The Initial Developer of the Original Code is Dick Balaska and BuckoSoft, Corp.

  * 

  */

 package com.buckosoft.fibs.BuckoFIBS.gui.chatWindow;

 import java.awt.Color;

 import java.awt.Dimension;

 import java.awt.Rectangle;

 import javax.swing.JScrollPane;

 import javax.swing.JTextPane;

 import javax.swing.text.BadLocationException;

 import javax.swing.text.Style;

 import javax.swing.text.StyleConstants;

 import javax.swing.text.StyleContext;

 import javax.swing.text.StyledDocument;

 /** Component that handles the Chat output.

  * @author Dick Balaska

  * @since 2008/10/01

  * @version $Revision$ <br> $Date$

  * @see <a href="http://cvs.buckosoft.com/Projects/BuckoFIBS/BuckoFIBS/src/main/java/com/buckosoft/fibs/BuckoFIBS/gui/chatWindow/ChatOutput.java">cvs ChatOutput.java</a>

  */

 public class ChatOutput extends JScrollPane {

         private static final long serialVersionUID = 1L;

         private        JTextPane                        textPane = new JTextPane();

         private Dimension                        chatOutDimension = null;  //  @jve:decl-index=0:

         private        Rectangle                        chatOutRectangle = null;

         private final static String eol = "\n";

         private final static int ST_NORMAL                = 0;

         private final static int ST_YOU                        = 1;

         private final static int ST_PLAYERSUB        = 2;        // Player is sentence subject

         private final static int ST_PLAYEROBJ        = 3;        // Player is sentence object

         private final static int ST_VERB                = 4;

         private final static int ST_VERB_WHISPER= 5;

         private final static int ST_MESSAGE                = 6;

         private final static int ST_LAST                 = 7;

         private        StyledDocument                 document;

         private        Style[] styles = new Style[ST_LAST];

         /** Default constructor

          */

         public ChatOutput() {

                 super(new JTextPane());

                 textPane = (JTextPane)this.getViewport().getComponent(0);

                 document = textPane.getStyledDocument();

                 addStylesToDocument(document);

                 initialize();

                 this.setVerticalScrollBarPolicy(JScrollPane.VERTICAL_SCROLLBAR_ALWAYS);

                 chatOutDimension = new Dimension(10,10);

                 chatOutRectangle = new Rectangle(10,10);

         }

         private void initialize() {

                 this.setSize(300, 200);

                 this.setVerticalScrollBarPolicy(JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED);

         }

         private void addStylesToDocument(StyledDocument doc) {

                 // Initialize some styles.

                 Style def = StyleContext.getDefaultStyleContext().getStyle(

                                 StyleContext.DEFAULT_STYLE);

                 styles[ST_NORMAL] = doc.addStyle("regular", def);

                 styles[ST_YOU] = doc.addStyle("you", styles[ST_NORMAL]);

                 StyleConstants.setForeground(styles[ST_YOU], new Color(178,41,223));

                 StyleConstants.setItalic(styles[ST_YOU], true);

                 styles[ST_PLAYERSUB] = doc.addStyle("player", styles[ST_NORMAL]);

                 StyleConstants.setBold(styles[ST_PLAYERSUB], true);

                 StyleConstants.setForeground(styles[ST_PLAYERSUB], new Color(63,66,193));

                 styles[ST_PLAYEROBJ] = doc.addStyle("player", styles[ST_NORMAL]);

                 StyleConstants.setForeground(styles[ST_PLAYEROBJ], new Color(63,66,193));

                 styles[ST_VERB] = doc.addStyle("verb", styles[ST_NORMAL]);

                 //StyleConstants.setBold(styles[ST_VERB], true);

                 //StyleConstants.setForeground(styles[ST_VERB], new Color(201,43,80));

                 StyleConstants.setForeground(styles[ST_VERB], new Color(55,100,227));

                 styles[ST_VERB_WHISPER] = doc.addStyle("verb", styles[ST_NORMAL]);

                 //StyleConstants.setBold(styles[ST_VERB], true);

                 //StyleConstants.setForeground(styles[ST_VERB], new Color(201,43,80));

                 StyleConstants.setForeground(styles[ST_VERB_WHISPER], new Color(55,198,126));

                 styles[ST_MESSAGE] = doc.addStyle("message", styles[ST_NORMAL]);

         }

         /** Write a plain message to the textpane.

          * @param message The message to write.

          */

         public void writeBareMessage(String message) {

                 appendStyledText(ST_MESSAGE, message + eol);

                 chatOutDimension = textPane.getSize(chatOutDimension);

                 chatOutRectangle.y = chatOutDimension.height;

                 try {

                         this.getViewport().scrollRectToVisible(chatOutRectangle);

                 } catch (Exception e) {/* ignore */}                

         }

         /** Write a message from another player to the textpane

          * @param name The name of the player who sent the message

          * @param verb The type of message sent

          * @param message The message

          */

         public void writeMessageFromPlayer(String name, String verb, String message) {

                 appendStyledText(ST_PLAYERSUB, name + " ");

                 appendStyledText(ST_VERB, verb + " ");

                 appendStyledText(ST_MESSAGE, message + eol);

                 chatOutDimension = textPane.getSize(chatOutDimension);

                 chatOutRectangle.y = chatOutDimension.height;

                 try {

                         this.getViewport().scrollRectToVisible(chatOutRectangle);

                 } catch (Exception e) {/* ignore */}

         }

         /** Write a message You sent in the textpane.

          * @param name The name of the player You sent the message to.  <br>

          *                                 Only useful for tell, "You tell bob hi!". <br>

          *                                 Null for kibitz and shout

          * @param verb The type of message you sent

          * @param message The message.

          */

         public void writeMessageFromYou(String name, String verb, String message) {

                 appendStyledText(ST_YOU, "You ");

                 if (verb.equals("whisper"))

                         appendStyledText(ST_VERB_WHISPER, verb + " ");

                 else

                         appendStyledText(ST_VERB, verb + " ");

                 if (name != null)

                         appendStyledText(ST_PLAYEROBJ, name + " ");

                 appendStyledText(ST_MESSAGE, message + eol);

                 chatOutDimension = textPane.getSize(chatOutDimension);

                 chatOutRectangle.y = chatOutDimension.height;

                 try {

                         this.getViewport().scrollRectToVisible(chatOutRectangle);

                 } catch (Exception e) {/* ignore */}

         }

         private void        appendStyledText(int style, String s) {

                 if (style < 0 || style > ST_LAST)

                         style = ST_NORMAL;

                 try {

                         this.document.insertString(this.document.getLength(), s, styles[style]);

                 } catch (BadLocationException e) {

                         e.printStackTrace();

                 }

         }

 }