core/loggers/SimpleSwingLogger.java

//---PACKAGE DECLARATION---

//---IMPORTS---
import uk.ac.ukc.iscream.core.*;
import java.util.Date;
import java.text.DateFormat;
import java.util.Locale;
import javax.swing.*;
import javax.swing.border.*;
import java.awt.Color;

/**
 * The SimpleGUILogger is an implementation of the LoggerImpl defined
 * in the associated interface. It's only purpose is to simply print
 * all the logging information it receives to a window frame.
 *
 * All very simple really...
 *
 * @author  $Author: ajm4 $
 * @version $Id: SimpleSwingLogger.java,v 1.1 2000/11/27 17:34:04 ajm4 Exp $
 */
class SimpleSwingLogger extends JFrame implements LoggerImpl {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.1 $";
    
    private final int width = 700;
    private final int height = 400;
    
//---STATIC METHODS---

//---CONSTRUCTORS---

    /**
     * Creates a new Simple Swing Logger.
     */
    public SimpleSwingLogger() {
        _verbosityLevel = Integer.parseInt(System.getProperty("uk.ac.ukc.iscream.Verbosity"));
        System.out.println(this.toString() + ": opening window");

        // set up the Frame
        setTitle("I-Scream Logger");
        setSize(width, height);
        getContentPane().setBackground(Color.white);
        setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
        Box box = Box.createVerticalBox();

        // create the i-scream logo at the top
        JLabel iscream = new JLabel(new ImageIcon("i-scream.gif"));
        iscream.setBackground(Color.white);
        Box header = Box.createHorizontalBox();
        header.add(Box.createHorizontalGlue());
        header.add(iscream);
        header.add(Box.createHorizontalGlue());

        // set up the text area
        _textArea.setEditable(false);
        JScrollPane text = new JScrollPane(_textArea);
        text.setBorder(new TitledBorder(new LineBorder(new Color(0, 0, 102)), " Messages "));
        text.setBackground(Color.white);

        // build the frame
        box.add(header);
        box.add(text);
        getContentPane().add(box);

        // show the window
        show();
        write(this.toString(), Logger.SYSINIT, "started");
        write(this.toString(), Logger.SYSMSG, "using verbosity " + _verbosityLevel);
    }

//---PUBLIC METHODS---

    /**
     * The write() method takes a message, formats it using the
     * formatLogLine() method, and then outputs it to the screen
     * using the text area. The source is usually the
     * calling object, referenced by `this'. The method has been
     * made synchronized to avoid it being called by two different
     * objects and the output ending up merged on the screen.
     * 
     * @param source A string representation of the calling object.
     * @param verbosity the verbosity of this message
     * @param message The text to be logged.
     */   
    public synchronized void write(String source, int verbosity, String message) {
        if (verbosity <= _verbosityLevel) {
            String line = formatLogLine(source, message);
            _textArea.insert(line + "\n",0);
        }
    }
       
    /**
     * Overrides the {@link java.lang.Object#toString() Object.toString()}
     * method to provide clean logging (every class should have this).
     *
     * @return the name of this class and its CVS revision
     */
    public String toString() {
        return this.getClass().getName() + "(" + REVISION.substring(11, REVISION.length() - 2) + ")";
        //return "ScreenLogger" + "(" + REVISION.substring(11, REVISION.length() - 2) + ")";
    }
//---PRIVATE METHODS---

    /**
     * This method generates a nicely formatted line for the log,
     * including the date/time and the source of the message. The date
     * and time are formatted using the DateFormat class, and the source
     * class is formatted using the toString() method found in every
     * source file. This is then prepended to the message and returned.
     * 
     * @param source A string representation of the calling object.
     * @param message The message to be logged.
     * @return The string to be written to the log.
     */
    private String formatLogLine(String source, String message){
        String date = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.MEDIUM).format(new Date());
        return "[" + date + "] " + source + ": " + message;
    }

//---ACCESSOR/MUTATOR METHODS---

//---ATTRIBUTES---

    /**
     * A text area to write log messages to
     */
    private JTextArea _textArea = new JTextArea();


    /**
     * The verbosity level of this instance
     */
    private int _verbosityLevel;
    
//---STATIC ATTRIBUTES---
    
}
Revision:	1.2
Committed:	Mon Nov 27 21:57:08 2000 UTC (23 years, 5 months ago) by ajm
Branch:	MAIN
Changes since 1.1:	+74 -48 lines
Log Message:	tidied it up a bit. now looks nice...has a better starting size, an i-scream logo, a bordered text area and in fitting with the i-scream colour scheme
#	Content
1	//---PACKAGE DECLARATION---
2
3	//---IMPORTS---
4	import uk.ac.ukc.iscream.core.*;
5	import java.util.Date;
6	import java.text.DateFormat;
7	import java.util.Locale;
8	import javax.swing.*;
9	import javax.swing.border.*;
10	import java.awt.Color;
11
12	/**
13	* The SimpleGUILogger is an implementation of the LoggerImpl defined
14	* in the associated interface. It's only purpose is to simply print
15	* all the logging information it receives to a window frame.
16	*
17	* All very simple really...
18	*
19	* @author $Author: ajm4 $
20	* @version $Id: SimpleSwingLogger.java,v 1.1 2000/11/27 17:34:04 ajm4 Exp $
21	*/
22	class SimpleSwingLogger extends JFrame implements LoggerImpl {
23
24	//---FINAL ATTRIBUTES---
25
26	/**
27	* The current CVS revision of this class
28	*/
29	public final String REVISION = "$Revision: 1.1 $";
30
31	private final int width = 700;
32	private final int height = 400;
33
34	//---STATIC METHODS---
35
36	//---CONSTRUCTORS---
37
38	/**
39	* Creates a new Simple Swing Logger.
40	*/
41	public SimpleSwingLogger() {
42	_verbosityLevel = Integer.parseInt(System.getProperty("uk.ac.ukc.iscream.Verbosity"));
43	System.out.println(this.toString() + ": opening window");
44
45	// set up the Frame
46	setTitle("I-Scream Logger");
47	setSize(width, height);
48	getContentPane().setBackground(Color.white);
49	setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
50	Box box = Box.createVerticalBox();
51
52	// create the i-scream logo at the top
53	JLabel iscream = new JLabel(new ImageIcon("i-scream.gif"));
54	iscream.setBackground(Color.white);
55	Box header = Box.createHorizontalBox();
56	header.add(Box.createHorizontalGlue());
57	header.add(iscream);
58	header.add(Box.createHorizontalGlue());
59
60	// set up the text area
61	_textArea.setEditable(false);
62	JScrollPane text = new JScrollPane(_textArea);
63	text.setBorder(new TitledBorder(new LineBorder(new Color(0, 0, 102)), " Messages "));
64	text.setBackground(Color.white);
65
66	// build the frame
67	box.add(header);
68	box.add(text);
69	getContentPane().add(box);
70
71	// show the window
72	show();
73	write(this.toString(), Logger.SYSINIT, "started");
74	write(this.toString(), Logger.SYSMSG, "using verbosity " + _verbosityLevel);
75	}
76
77	//---PUBLIC METHODS---
78
79	/**
80	* The write() method takes a message, formats it using the
81	* formatLogLine() method, and then outputs it to the screen
82	* using the text area. The source is usually the
83	* calling object, referenced by `this'. The method has been
84	* made synchronized to avoid it being called by two different
85	* objects and the output ending up merged on the screen.
86	*
87	* @param source A string representation of the calling object.
88	* @param verbosity the verbosity of this message
89	* @param message The text to be logged.
90	*/
91	public synchronized void write(String source, int verbosity, String message) {
92	if (verbosity <= _verbosityLevel) {
93	String line = formatLogLine(source, message);
94	_textArea.insert(line + "\n",0);
95	}
96	}
97
98	/**
99	* Overrides the {@link java.lang.Object#toString() Object.toString()}
100	* method to provide clean logging (every class should have this).
101	*
102	* @return the name of this class and its CVS revision
103	*/
104	public String toString() {
105	return this.getClass().getName() + "(" + REVISION.substring(11, REVISION.length() - 2) + ")";
106	//return "ScreenLogger" + "(" + REVISION.substring(11, REVISION.length() - 2) + ")";
107	}
108	//---PRIVATE METHODS---
109
110	/**
111	* This method generates a nicely formatted line for the log,
112	* including the date/time and the source of the message. The date
113	* and time are formatted using the DateFormat class, and the source
114	* class is formatted using the toString() method found in every
115	* source file. This is then prepended to the message and returned.
116	*
117	* @param source A string representation of the calling object.
118	* @param message The message to be logged.
119	* @return The string to be written to the log.
120	*/
121	private String formatLogLine(String source, String message){
122	String date = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.MEDIUM).format(new Date());
123	return "[" + date + "] " + source + ": " + message;
124	}
125
126	//---ACCESSOR/MUTATOR METHODS---
127
128	//---ATTRIBUTES---
129
130	/**
131	* A text area to write log messages to
132	*/
133	private JTextArea _textArea = new JTextArea();
134
135
136	/**
137	* The verbosity level of this instance
138	*/
139	private int _verbosityLevel;
140
141	//---STATIC ATTRIBUTES---
142
143	}