mirror of
https://github.com/igniterealtime/Spark.git
synced 2025-12-01 12:27:58 +00:00
Initial checkin of Spark Open Source
git-svn-id: http://svn.igniterealtime.org/svn/repos/spark/trunk@4456 b35dd754-fafc-0310-a699-88a17e54d16e
This commit is contained in:
Derek DeMoro
derek
536
src/java/org/jivesoftware/spark/ui/TranscriptWindow.java
Normal file
536
src/java/org/jivesoftware/spark/ui/TranscriptWindow.java
Normal file
@ -0,0 +1,536 @@
|
||||
/**
|
||||
* $Revision: $
|
||||
* $Date: $
|
||||
*
|
||||
* Copyright (C) 2006 Jive Software. All rights reserved.
|
||||
*
|
||||
* This software is published under the terms of the GNU Lesser Public License (LGPL),
|
||||
* a copy of which is included in this distribution.
|
||||
*/
|
||||
|
||||
package org.jivesoftware.spark.ui;
|
||||
|
||||
import org.jivesoftware.Spark;
|
||||
import org.jivesoftware.resource.SparkRes;
|
||||
import org.jivesoftware.smack.packet.Message;
|
||||
import org.jivesoftware.smack.util.StringUtils;
|
||||
import org.jivesoftware.spark.SparkManager;
|
||||
import org.jivesoftware.spark.plugin.ContextMenuListener;
|
||||
import org.jivesoftware.spark.preference.PreferenceManager;
|
||||
import org.jivesoftware.spark.util.ModelUtil;
|
||||
import org.jivesoftware.spark.util.log.Log;
|
||||
import org.jivesoftware.sparkimpl.preference.chat.ChatPreference;
|
||||
import org.jivesoftware.sparkimpl.preference.chat.ChatPreferences;
|
||||
|
||||
import javax.swing.AbstractAction;
|
||||
import javax.swing.Action;
|
||||
import javax.swing.JComponent;
|
||||
import javax.swing.JFileChooser;
|
||||
import javax.swing.JOptionPane;
|
||||
import javax.swing.JPopupMenu;
|
||||
import javax.swing.KeyStroke;
|
||||
import javax.swing.UIManager;
|
||||
import javax.swing.text.BadLocationException;
|
||||
import javax.swing.text.Document;
|
||||
import javax.swing.text.SimpleAttributeSet;
|
||||
import javax.swing.text.Style;
|
||||
import javax.swing.text.StyleConstants;
|
||||
import javax.swing.text.StyledDocument;
|
||||
|
||||
import java.awt.Color;
|
||||
import java.awt.Component;
|
||||
import java.awt.Font;
|
||||
import java.awt.Toolkit;
|
||||
import java.awt.datatransfer.StringSelection;
|
||||
import java.awt.event.ActionEvent;
|
||||
import java.awt.event.MouseEvent;
|
||||
import java.io.BufferedWriter;
|
||||
import java.io.File;
|
||||
import java.io.FileWriter;
|
||||
import java.text.SimpleDateFormat;
|
||||
import java.util.Date;
|
||||
import java.util.Iterator;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* The <CODE>TranscriptWindow</CODE> class. Provides a default implementation
|
||||
* of a Chat Window. In general, extensions could override this class
|
||||
* to offer more support within the chat, but should not be necessary.
|
||||
*/
|
||||
public class TranscriptWindow extends ChatArea {
|
||||
|
||||
|
||||
private ChatPreferences chatPref;
|
||||
private Date lastUpdated;
|
||||
|
||||
/**
|
||||
* The default font used in the chat window for all messages.
|
||||
*/
|
||||
private Font font = new Font("Dialog", Font.PLAIN, 12);
|
||||
|
||||
|
||||
/**
|
||||
* Creates a default instance of <code>TranscriptWindow</code>.
|
||||
*/
|
||||
public TranscriptWindow() {
|
||||
setEditable(false);
|
||||
|
||||
/* Load Preferences for this instance */
|
||||
PreferenceManager preferenceManager = SparkManager.getPreferenceManager();
|
||||
chatPref = (ChatPreferences)preferenceManager.getPreferenceData(ChatPreference.NAMESPACE);
|
||||
|
||||
addMouseListener(this);
|
||||
addMouseMotionListener(this);
|
||||
setDragEnabled(true);
|
||||
|
||||
final TranscriptWindow window = this;
|
||||
addContextMenuListener(new ContextMenuListener() {
|
||||
public void poppingUp(Object component, JPopupMenu popup) {
|
||||
Action printAction = new AbstractAction() {
|
||||
public void actionPerformed(ActionEvent actionEvent) {
|
||||
SparkManager.printChatTranscript(window);
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
Action clearAction = new AbstractAction() {
|
||||
public void actionPerformed(ActionEvent actionEvent) {
|
||||
clear();
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
printAction.putValue(Action.NAME, "Print");
|
||||
printAction.putValue(Action.SMALL_ICON, SparkRes.getImageIcon(SparkRes.PRINTER_IMAGE_16x16));
|
||||
|
||||
clearAction.putValue(Action.NAME, "Clear");
|
||||
clearAction.putValue(Action.SMALL_ICON, SparkRes.getImageIcon(SparkRes.ERASER_IMAGE));
|
||||
popup.addSeparator();
|
||||
popup.add(printAction);
|
||||
|
||||
popup.add(clearAction);
|
||||
}
|
||||
|
||||
public void poppingDown(JPopupMenu popup) {
|
||||
|
||||
}
|
||||
|
||||
public boolean handleDefaultAction(MouseEvent e) {
|
||||
return false;
|
||||
}
|
||||
});
|
||||
|
||||
// Make sure ctrl-c works
|
||||
getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(KeyStroke.getKeyStroke("control c"), "copy");
|
||||
|
||||
getActionMap().put("copy", new AbstractAction("copy") {
|
||||
public void actionPerformed(ActionEvent evt) {
|
||||
StringSelection ss = new StringSelection(getSelectedText());
|
||||
Toolkit.getDefaultToolkit().getSystemClipboard().setContents(ss, null);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
public void addComponent(Component component) {
|
||||
StyledDocument doc = (StyledDocument)getDocument();
|
||||
|
||||
// The image must first be wrapped in a style
|
||||
Style style = doc.addStyle("StyleName", null);
|
||||
|
||||
|
||||
StyleConstants.setComponent(style, component);
|
||||
|
||||
// Insert the image at the end of the text
|
||||
try {
|
||||
doc.insertString(doc.getLength(), "ignored text", style);
|
||||
doc.insertString(doc.getLength(), "\n", null);
|
||||
}
|
||||
catch (BadLocationException e) {
|
||||
Log.error(e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create and insert a message from the current user.
|
||||
*
|
||||
* @param userid the userid of the current agent.
|
||||
* @param message the agents message to insert.
|
||||
*/
|
||||
public void insertMessage(String userid, String message) {
|
||||
|
||||
try {
|
||||
String date = getDate(null);
|
||||
|
||||
// Agent color is always blue
|
||||
StyleConstants.setBold(styles, false);
|
||||
StyleConstants.setForeground(styles, (Color)UIManager.get("User.foreground"));
|
||||
final Document doc = getDocument();
|
||||
styles.removeAttribute("link");
|
||||
|
||||
StyleConstants.setFontSize(styles, font.getSize());
|
||||
doc.insertString(doc.getLength(), date + userid + ": ", styles);
|
||||
|
||||
// Reset Styles for message
|
||||
StyleConstants.setBold(styles, false);
|
||||
setText(message);
|
||||
insertText("\n");
|
||||
}
|
||||
catch (BadLocationException e) {
|
||||
Log.error("Error message.", e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create and insert a message from the current user.
|
||||
*
|
||||
* @param userid the userid of the current agent.
|
||||
* @param message the agents message to insert.
|
||||
* @param datePosted the date the message was posted.
|
||||
*/
|
||||
public void insertMessage(String userid, String message, Date datePosted) {
|
||||
|
||||
try {
|
||||
String date = getDate(datePosted);
|
||||
|
||||
// Agent color is always blue
|
||||
StyleConstants.setBold(styles, false);
|
||||
StyleConstants.setForeground(styles, (Color)UIManager.get("User.foreground"));
|
||||
final Document doc = getDocument();
|
||||
styles.removeAttribute("link");
|
||||
|
||||
StyleConstants.setFontSize(styles, font.getSize());
|
||||
doc.insertString(doc.getLength(), date + userid + ": ", styles);
|
||||
|
||||
// Reset Styles for message
|
||||
StyleConstants.setBold(styles, false);
|
||||
setText(message);
|
||||
insertText("\n");
|
||||
}
|
||||
catch (BadLocationException e) {
|
||||
Log.error("Error message.", e);
|
||||
}
|
||||
}
|
||||
|
||||
public void insertCustomMessage(String prefix, String message) {
|
||||
try {
|
||||
// Agent color is always blue
|
||||
StyleConstants.setBold(styles, false);
|
||||
StyleConstants.setForeground(styles, (Color)UIManager.get("User.foreground"));
|
||||
final Document doc = getDocument();
|
||||
styles.removeAttribute("link");
|
||||
|
||||
StyleConstants.setFontSize(styles, font.getSize());
|
||||
if (prefix != null) {
|
||||
doc.insertString(doc.getLength(), prefix + ": ", styles);
|
||||
}
|
||||
|
||||
// Reset Styles for message
|
||||
StyleConstants.setBold(styles, false);
|
||||
setText(message);
|
||||
insertText("\n");
|
||||
}
|
||||
catch (BadLocationException e) {
|
||||
Log.error("Error message.", e);
|
||||
}
|
||||
}
|
||||
|
||||
public void insertCustomOtherMessage(String prefix, String message) {
|
||||
try {
|
||||
StyleConstants.setBold(styles, false);
|
||||
StyleConstants.setForeground(styles, (Color)UIManager.get("OtherUser.foreground"));
|
||||
final Document doc = getDocument();
|
||||
styles.removeAttribute("link");
|
||||
|
||||
StyleConstants.setFontSize(styles, font.getSize());
|
||||
doc.insertString(doc.getLength(), prefix + ": ", styles);
|
||||
|
||||
StyleConstants.setBold(styles, false);
|
||||
setText(message);
|
||||
insertText("\n");
|
||||
}
|
||||
catch (BadLocationException ex) {
|
||||
Log.error("Error message.", ex);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create and insert a message from a customer.
|
||||
*
|
||||
* @param userid the userid of the customer.
|
||||
* @param message the message from the customer.
|
||||
* @param date the date the message was posted, can be null.
|
||||
*/
|
||||
public void insertOthersMessage(String userid, String message, Date date) {
|
||||
try {
|
||||
String theDate = getDate(date);
|
||||
|
||||
StyleConstants.setBold(styles, false);
|
||||
StyleConstants.setForeground(styles, (Color)UIManager.get("OtherUser.foreground"));
|
||||
final Document doc = getDocument();
|
||||
styles.removeAttribute("link");
|
||||
|
||||
StyleConstants.setFontSize(styles, font.getSize());
|
||||
doc.insertString(doc.getLength(), theDate + userid + ": ", styles);
|
||||
|
||||
StyleConstants.setBold(styles, false);
|
||||
setText(message);
|
||||
insertText("\n");
|
||||
}
|
||||
catch (BadLocationException ex) {
|
||||
Log.error("Error message.", ex);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Create and insert a notification message. A notification message generally is a
|
||||
* presence update, but can be used for most anything related to the room.
|
||||
*
|
||||
* @param message the information message to insert.
|
||||
*/
|
||||
public synchronized void insertNotificationMessage(String message) {
|
||||
try {
|
||||
|
||||
Color notificationColor = (Color)UIManager.get("Notification.foreground");
|
||||
|
||||
// Agent color is always blue
|
||||
StyleConstants.setBold(styles, false);
|
||||
StyleConstants.setForeground(styles, notificationColor);
|
||||
final Document doc = getDocument();
|
||||
styles.removeAttribute("link");
|
||||
|
||||
StyleConstants.setFontSize(styles, font.getSize());
|
||||
doc.insertString(doc.getLength(), "", styles);
|
||||
|
||||
// Reset Styles for message
|
||||
StyleConstants.setBold(styles, false);
|
||||
setForeground(notificationColor);
|
||||
setText(message);
|
||||
insertText("\n");
|
||||
setForeground(Color.black);
|
||||
}
|
||||
catch (BadLocationException ex) {
|
||||
Log.error("Error message.", ex);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates and inserts an error message.
|
||||
*
|
||||
* @param message the information message to insert.
|
||||
*/
|
||||
public void insertErrorMessage(String message) {
|
||||
try {
|
||||
// Agent color is always blue
|
||||
StyleConstants.setBold(styles, false);
|
||||
StyleConstants.setForeground(styles, (Color)UIManager.get("Error.foreground"));
|
||||
final Document doc = getDocument();
|
||||
styles.removeAttribute("link");
|
||||
|
||||
StyleConstants.setFontSize(styles, font.getSize());
|
||||
doc.insertString(doc.getLength(), "", styles);
|
||||
|
||||
// Reset Styles for message
|
||||
StyleConstants.setBold(styles, false);
|
||||
setForeground(Color.red);
|
||||
setText(message);
|
||||
insertText("\n");
|
||||
setForeground(Color.black);
|
||||
}
|
||||
catch (BadLocationException ex) {
|
||||
Log.error("Error message.", ex);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create and insert a question message. A question message is specified by the
|
||||
* end customer during the initial request.
|
||||
*
|
||||
* @param question the question asked by the customer.
|
||||
*/
|
||||
public void insertQuestionMessage(String question) {
|
||||
|
||||
try {
|
||||
StyleConstants.setBold(styles, false);
|
||||
StyleConstants.setForeground(styles, (Color)UIManager.get("Question.foreground"));
|
||||
final Document doc = getDocument();
|
||||
styles.removeAttribute("link");
|
||||
|
||||
StyleConstants.setFontSize(styles, font.getSize());
|
||||
StyleConstants.setFontFamily(styles, font.getFamily());
|
||||
doc.insertString(doc.getLength(), "Question - ", styles);
|
||||
|
||||
StyleConstants.setBold(styles, false);
|
||||
setText(question);
|
||||
insertText("\n");
|
||||
}
|
||||
catch (BadLocationException e) {
|
||||
Log.error("Error message.", e);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Returns the formatted date.
|
||||
*
|
||||
* @param insertDate the date to format.
|
||||
* @return the formatted date.
|
||||
*/
|
||||
private String getDate(Date insertDate) {
|
||||
chatPref = (ChatPreferences)SparkManager.getPreferenceManager().getPreferenceData(ChatPreference.NAMESPACE);
|
||||
|
||||
if (insertDate == null) {
|
||||
insertDate = new Date();
|
||||
}
|
||||
|
||||
StyleConstants.setFontFamily(styles, font.getFontName());
|
||||
StyleConstants.setFontSize(styles, font.getSize());
|
||||
|
||||
if (chatPref.showDatesInChat()) {
|
||||
final SimpleDateFormat formatter = new SimpleDateFormat("h:mm a");
|
||||
final String date = formatter.format(insertDate);
|
||||
|
||||
return "[" + date + "] ";
|
||||
}
|
||||
lastUpdated = insertDate;
|
||||
return "";
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Return the last time the <code>TranscriptWindow</code> was updated.
|
||||
*
|
||||
* @return the last time the <code>TranscriptWindow</code> was updated.
|
||||
*/
|
||||
public Date getLastUpdated() {
|
||||
return lastUpdated;
|
||||
}
|
||||
|
||||
/**
|
||||
* Inserts a history message.
|
||||
*
|
||||
* @param userid the userid of the sender.
|
||||
* @param message the message to insert.
|
||||
* @param date the Date object created when the message was delivered.
|
||||
*/
|
||||
public void insertHistoryMessage(String userid, String message, Date date) {
|
||||
try {
|
||||
String value = "";
|
||||
|
||||
final SimpleDateFormat formatter = new SimpleDateFormat("MM/dd/yyyy h:mm a");
|
||||
value = "[" + formatter.format(date) + "] ";
|
||||
value = value + userid + ": ";
|
||||
|
||||
// Agent color is always blue
|
||||
StyleConstants.setBold(styles, false);
|
||||
StyleConstants.setForeground(styles, Color.LIGHT_GRAY);
|
||||
final Document doc = getDocument();
|
||||
styles.removeAttribute("link");
|
||||
|
||||
StyleConstants.setFontSize(styles, font.getSize());
|
||||
doc.insertString(doc.getLength(), value, styles);
|
||||
|
||||
// Reset Styles for message
|
||||
StyleConstants.setBold(styles, false);
|
||||
setForeground(Color.LIGHT_GRAY);
|
||||
setText(message);
|
||||
setForeground(Color.BLACK);
|
||||
insertText("\n");
|
||||
}
|
||||
catch (BadLocationException ex) {
|
||||
Log.error("Error message.", ex);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Disable the entire <code>TranscriptWindow</code> and visually represent
|
||||
* it as disabled.
|
||||
*/
|
||||
public void showDisabledWindowUI() {
|
||||
final Document document = getDocument();
|
||||
final SimpleAttributeSet attrs = new SimpleAttributeSet();
|
||||
StyleConstants.setForeground(attrs, Color.LIGHT_GRAY);
|
||||
|
||||
final int length = document.getLength();
|
||||
StyledDocument styledDocument = getStyledDocument();
|
||||
styledDocument.setCharacterAttributes(0, length, attrs, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Persist a current transcript.
|
||||
*
|
||||
* @param fileName the name of the file to save the transcript as. Note: This can be modified by the user.
|
||||
* @param transcript the collection of transcript.
|
||||
* @param headerData the string to prepend to the transcript.
|
||||
* @see ChatRoom#getTranscripts()
|
||||
*/
|
||||
public void saveTranscript(String fileName, List transcript, String headerData) {
|
||||
try {
|
||||
SimpleDateFormat formatter;
|
||||
|
||||
File defaultSaveFile = new File(new File(Spark.getUserHome()), fileName);
|
||||
final JFileChooser fileChooser = new JFileChooser(defaultSaveFile);
|
||||
fileChooser.setSelectedFile(defaultSaveFile);
|
||||
|
||||
// Show save dialog; this method does not return until the dialog is closed
|
||||
int result = fileChooser.showSaveDialog(this);
|
||||
final File selFile = fileChooser.getSelectedFile();
|
||||
|
||||
if (selFile != null && result == JFileChooser.APPROVE_OPTION) {
|
||||
final StringBuffer buf = new StringBuffer();
|
||||
final Iterator transcripts = transcript.iterator();
|
||||
buf.append("<html><body>");
|
||||
if (headerData != null) {
|
||||
buf.append(headerData);
|
||||
}
|
||||
|
||||
buf.append("<table width=600>");
|
||||
while (transcripts.hasNext()) {
|
||||
final Message message = (Message)transcripts.next();
|
||||
String from = message.getFrom();
|
||||
if (from == null) {
|
||||
from = chatPref.getNickname();
|
||||
}
|
||||
|
||||
if (Message.Type.GROUP_CHAT == message.getType()) {
|
||||
if (ModelUtil.hasLength(StringUtils.parseResource(from))) {
|
||||
from = StringUtils.parseResource(from);
|
||||
}
|
||||
}
|
||||
|
||||
final String body = message.getBody();
|
||||
final Date insertionDate = (Date)message.getProperty("insertionDate");
|
||||
formatter = new SimpleDateFormat("hh:mm:ss");
|
||||
|
||||
String value = "";
|
||||
if (insertionDate != null) {
|
||||
value = "[" + formatter.format(insertionDate) + "] ";
|
||||
}
|
||||
buf.append("<tr><td nowrap><font size=2>").append(value).append("<strong>").append(from).append(":</strong> ").append(body).append("</font></td></tr>");
|
||||
|
||||
}
|
||||
buf.append("</table></body></html>");
|
||||
final BufferedWriter writer = new BufferedWriter(new FileWriter(selFile));
|
||||
writer.write(buf.toString());
|
||||
writer.close();
|
||||
JOptionPane.showMessageDialog(SparkManager.getMainWindow(), "Chat transcript has been saved.",
|
||||
"Chat Transcript Saved", JOptionPane.INFORMATION_MESSAGE);
|
||||
}
|
||||
}
|
||||
catch (Exception ex) {
|
||||
Log.error("Unable to save chat transcript.", ex);
|
||||
JOptionPane.showMessageDialog(SparkManager.getMainWindow(), "Could not save transcript.", "Error", JOptionPane.ERROR_MESSAGE);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
public void setFont(Font font) {
|
||||
this.font = font;
|
||||
}
|
||||
|
||||
public Font getFont() {
|
||||
return font;
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user