/jEdit/tags/jedit-4-0-pre3/org/gjt/sp/jedit/msg/BufferUpdate.java

  1/*
  2 * BufferUpdate.java - Buffer update message
  3 * :tabSize=8:indentSize=8:noTabs=false:
  4 * :folding=explicit:collapseFolds=1:
  5 *
  6 * Copyright (C) 1999, 2001 Slava Pestov
  7 *
  8 * This program is free software; you can redistribute it and/or
  9 * modify it under the terms of the GNU General Public License
 10 * as published by the Free Software Foundation; either version 2
 11 * of the License, or any later version.
 12 *
 13 * This program is distributed in the hope that it will be useful,
 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 16 * GNU General Public License for more details.
 17 *
 18 * You should have received a copy of the GNU General Public License
 19 * along with this program; if not, write to the Free Software
 20 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 21 */
 22
 23package org.gjt.sp.jedit.msg;
 24
 25import org.gjt.sp.jedit.*;
 26
 27/**
 28 * Message sent when a buffer-related change occurs.
 29 * @author Slava Pestov
 30 * @version $Id: BufferUpdate.java 5540 2006-07-06 10:02:29Z  $
 31 *
 32 * @since jEdit 2.2pre6
 33 */
 34public class BufferUpdate extends EBMessage.NonVetoable
 35{
 36	//{{{ Message types
 37	/**
 38	 * Buffer created.
 39	 */
 40	public static final Object CREATED = "CREATED";
 41
 42	/**
 43	 * Buffer load started.
 44	 * @since jEdit 2.6pre1
 45	 */
 46	public static final Object LOAD_STARTED = "LOAD_STARTED";
 47
 48	/**
 49	 * Buffer loaded.
 50	 */
 51	public static final Object LOADED = "LOADED";
 52
 53	/**
 54	 * Buffer closed.
 55	 */
 56	public static final Object CLOSED = "CLOSED";
 57
 58	/**
 59	 * Buffer dirty changed.
 60	 */
 61	public static final Object DIRTY_CHANGED = "DIRTY_CHANGED";
 62
 63	/**
 64	 * Buffer markers changed.
 65	 */
 66	public static final Object MARKERS_CHANGED = "MARKERS_CHANGED";
 67
 68	/**
 69	 * Buffer mode changed.
 70	 */
 71	public static final Object MODE_CHANGED = "MODE_CHANGED";
 72
 73	/**
 74	 * Character encoding changed.
 75	 * @since jEdit 3.2pre4
 76	 */
 77	public static final Object ENCODING_CHANGED = "ENCODING_CHANGED";
 78
 79	/**
 80	 * Fold handler changed.
 81	 * @since jEdit 4.0pre1
 82	 */
 83	public static final Object FOLD_HANDLER_CHANGED = "FOLD_HANDLER_CHANGED";
 84
 85	/**
 86	 * Buffer saving.
 87	 */
 88	public static final Object SAVING = "SAVING";
 89	//}}}
 90
 91	//{{{ BufferUpdate constructor
 92	/**
 93	 * Creates a new buffer update message.
 94	 * @param buffer The buffer
 95	 * @param what What happened
 96	 */
 97	public BufferUpdate(Buffer buffer, View view, Object what)
 98	{
 99		super(buffer);
100
101		this.view = view;
102
103		if(what == null)
104			throw new NullPointerException("What must be non-null");
105
106		this.what = what;
107	} //}}}
108
109	//{{{ getWhat() method
110	/**
111	 * Returns what caused this buffer update.
112	 */
113	public Object getWhat()
114	{
115		return what;
116	} //}}}
117
118	//{{{ getBuffer() method
119	/**
120	 * Returns the buffer involved.
121	 */
122	public Buffer getBuffer()
123	{
124		return (Buffer)getSource();
125	} //}}}
126
127	//{{{ getView() method
128	/**
129	 * Returns the view involved, which may be null.
130	 */
131	public View getView()
132	{
133		return view;
134	} //}}}
135
136	//{{{ paramString() method
137	public String paramString()
138	{
139		return super.paramString() + ",what=" + what
140			+ ",view=" + view;
141	} //}}}
142
143	//{{{ Private members
144	private Object what;
145	private View view;
146	//}}}
147}