/jEdit/tags/jedit-4-2-pre4/org/gjt/sp/jedit/msg/EditPaneUpdate.java

 1/*
 2 * EditPaneUpdate.java - Edit pane update message
 3 * Copyright (C) 1999, 2000 Slava Pestov
 4 *
 5 * This program is free software; you can redistribute it and/or
 6 * modify it under the terms of the GNU General Public License
 7 * as published by the Free Software Foundation; either version 2
 8 * of the License, or any later version.
 9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18 */
19
20package org.gjt.sp.jedit.msg;
21
22import org.gjt.sp.jedit.*;
23
24/**
25 * Message sent when an edit pane-related change occurs.
26 * @author Slava Pestov
27 * @version $Id: EditPaneUpdate.java 4428 2003-01-12 03:08:25Z spestov $
28 *
29 * @since jEdit 2.5pre1
30 */
31public class EditPaneUpdate extends EBMessage
32{
33	/**
34	 * Edit pane created.
35	 */
36	public static final Object CREATED = "CREATED";
37
38	/**
39	 * Edit pane destroyed.
40	 */
41	public static final Object DESTROYED = "DESTROYED";
42
43	/**
44	 * Edit pane buffer changed.
45	 */
46	public static final Object BUFFER_CHANGED = "BUFFER_CHANGED";
47
48	/**
49	 * Creates a new edit pane update message.
50	 * @param editPane The edit pane
51	 * @param what What happened
52	 */
53	public EditPaneUpdate(EditPane editPane, Object what)
54	{
55		super(editPane);
56
57		if(what == null)
58			throw new NullPointerException("What must be non-null");
59
60		this.what = what;
61	}
62
63	/**
64	 * Returns what caused this edit pane update.
65	 */
66	public Object getWhat()
67	{
68		return what;
69	}
70
71	/**
72	 * Returns the edit pane involved.
73	 */
74	public EditPane getEditPane()
75	{
76		return (EditPane)getSource();
77	}
78
79	public String paramString()
80	{
81		return "what=" + what + "," + super.paramString();
82	}
83
84	// private members
85	private Object what;
86}