/*
* BufferUpdate.java - Buffer update message
* :tabSize=4:indentSize=4:noTabs=false:
* :folding=explicit:collapseFolds=1:
*
* Copyright (C) 1999, 2001 Slava Pestov
*
* 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 2
* of the License, or 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, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
package org.gjt.sp.jedit.msg;
import org.gjt.sp.jedit.*;
/**
* Message sent when a buffer-related change occurs.
* @author Slava Pestov
* @version $Id: BufferUpdate.java 21831 2012-06-18 22:54:17Z ezust $
*
* @since jEdit 2.2pre6
*/
public class BufferUpdate extends EBMessage
{
//{{{ Message types
/**
* Buffer created.
*/
public static final Object CREATED = "CREATED";
/**
* About to be closed
* @since jEdit 4.2pre3
*/
public static final Object CLOSING = "CLOSING";
/**
* Buffer load started.
* @since jEdit 2.6pre1
*/
public static final Object LOAD_STARTED = "LOAD_STARTED";
/**
* Buffer loaded.
*/
public static final Object LOADED = "LOADED";
/**
* Buffer closed.
*/
public static final Object CLOSED = "CLOSED";
/**
* Buffer dirty changed.
*/
public static final Object DIRTY_CHANGED = "DIRTY_CHANGED";
/**
* Buffer markers changed.
*/
public static final Object MARKERS_CHANGED = "MARKERS_CHANGED";
/**
* Buffer saving.
*/
public static final Object SAVING = "SAVING";
/**
* Buffer saved.
* @since jEdit 4.0pre4
*/
public static final Object SAVED = "SAVED";
/**
* Properties changed.
* @since jEdit 4.1pre1
*/
public static final Object PROPERTIES_CHANGED = "PROPERTIES_CHANGED";
//}}}
//{{{ BufferUpdate constructor
/**
* Creates a new buffer update message.
* @param buffer The buffer
* @param what What happened
*/
public BufferUpdate(Buffer buffer, View view, Object what)
{
super(buffer);
this.view = view;
if(what == null)
throw new NullPointerException("What must be non-null");
this.what = what;
} //}}}
//{{{ getWhat() method
/**
* Returns what caused this buffer update.
*/
public Object getWhat()
{
return what;
} //}}}
//{{{ getBuffer() method
/**
* Returns the buffer involved.
*/
public Buffer getBuffer()
{
return (Buffer)getSource();
} //}}}
//{{{ getView() method
/**
* Returns the view involved, which may be null.
*/
public View getView()
{
return view;
} //}}}
//{{{ paramString() method
public String paramString()
{
return "what=" + what + ",view=" + view + ","
+ super.paramString();
} //}}}
//{{{ Private members
private Object what;
private View view;
//}}}
}