editorListener.handlers
Class UpdatedEditor

java.lang.Object
  extended by editorListener.handlers.UpdatedEditor
All Implemented Interfaces:
java.lang.Comparable<UpdatedEditor>

public class UpdatedEditor
extends java.lang.Object
implements java.lang.Comparable<UpdatedEditor>

This data class holds references to all of the objects that represent the updated object. Note: This is a data class. It is felt that the decision to provide getters is acceptable.

Version:
3/8/2009
Author:
Matthew Harward

Constructor Summary
UpdatedEditor(org.eclipse.jface.text.IDocument theDocument, org.eclipse.ui.IWorkbenchPart thePart, EditorState theState)
          The primary constructor.
 
Method Summary
 int compareTo(UpdatedEditor o)
           
 org.eclipse.jface.text.IDocument getDocument()
          Gets the document representing the contents of the editor.
 org.eclipse.core.runtime.IPath getPath()
          Gets the path of the current document.
 EditorState getTheState()
          Gets the state of the current editor.
 org.eclipse.ui.IWorkbenchPart getWorkbenchPart()
          Gets the part representing the editor in the eclipse workbench.
 java.lang.String toString()
          Overrides the toString method.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UpdatedEditor

public UpdatedEditor(org.eclipse.jface.text.IDocument theDocument,
                     org.eclipse.ui.IWorkbenchPart thePart,
                     EditorState theState)
The primary constructor.

Parameters:
theDocument - the document representing the current editor's contents.
thePart - the workbench part of the current editor.
theState - the defined state of the current editor.
Method Detail

getDocument

public org.eclipse.jface.text.IDocument getDocument()
Gets the document representing the contents of the editor.

Returns:
the document.

getWorkbenchPart

public org.eclipse.ui.IWorkbenchPart getWorkbenchPart()
Gets the part representing the editor in the eclipse workbench.

Returns:
the editor.

getTheState

public EditorState getTheState()
Gets the state of the current editor.

Returns:
the state.

getPath

public org.eclipse.core.runtime.IPath getPath()
Gets the path of the current document.

Returns:
the path

toString

public java.lang.String toString()
Overrides the toString method.

Overrides:
toString in class java.lang.Object

compareTo

public int compareTo(UpdatedEditor o)
Specified by:
compareTo in interface java.lang.Comparable<UpdatedEditor>