projectviewer.event

Class ViewerUpdate

java.lang.Object

org.gjt.sp.jedit.EBMessage

projectviewer.event.ViewerUpdate

public final class ViewerUpdate
extends org.gjt.sp.jedit.EBMessage

A project viewer update message sent on the Edit Bus.

Since:

PV 3.0.0

Author:

Marcelo Vanzin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ViewerUpdate.Type

Constructor Summary

Constructors

Constructor and Description
ViewerUpdate(ProjectViewer v, VPTNode n, ViewerUpdate.Type type) Construct a new message with the given type and an associated viewer.
ViewerUpdate(org.gjt.sp.jedit.View v, VPTNode n, ViewerUpdate.Type type) Construct a new message with the given type and no associated viewer.

Method Summary

Methods

Modifier and Type	Method and Description
VPTNode	getNode()
ViewerUpdate.Type	getType()
org.gjt.sp.jedit.View	getView() Returns the view where the event occurred.
ProjectViewer	getViewer() Returns the ProjectViewer.

Methods inherited from class org.gjt.sp.jedit.EBMessage

getSource, paramString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ViewerUpdate

public ViewerUpdate(org.gjt.sp.jedit.View v,
            VPTNode n,
            ViewerUpdate.Type type)

Construct a new message with the given type and no associated viewer. getViewer() might still return a viewer, if the dockable for the view is activated.

ViewerUpdate

public ViewerUpdate(ProjectViewer v,
            VPTNode n,
            ViewerUpdate.Type type)

Construct a new message with the given type and an associated viewer.

Method Detail

getType

public ViewerUpdate.Type getType()

Returns:

The event type of this message.

getViewer

public ProjectViewer getViewer()

Returns the ProjectViewer. This may be null if the dockable hasn't been activated yet.

getNode

public VPTNode getNode()

getView

public org.gjt.sp.jedit.View getView()

Returns the view where the event occurred.