org.acm.seguin.ide.common.action
Class CurrentSummary

java.lang.Object
  extended by org.acm.seguin.ide.common.action.CurrentSummary
All Implemented Interfaces:
java.util.EventListener, javax.swing.event.DocumentListener
Direct Known Subclasses:
JBuilderCurrentSummary

public abstract class CurrentSummary
extends java.lang.Object
implements javax.swing.event.DocumentListener

Determines what the current summary is based on the information from the IDE.

Version:
$Id: CurrentSummary.java,v 1.5 2003/11/19 20:36:24 mikeatkinson Exp $
Author:
Chris Seguin, Mike Atkinson

Field Summary
 int lineNo
           
protected  boolean upToDate
          Has this file changed since the last time this was invoked
 
Constructor Summary
protected CurrentSummary()
          Constructor for the CurrentSummary object
 
Method Summary
 void changedUpdate(javax.swing.event.DocumentEvent evt)
          Method that receives notification when the editor changes
static CurrentSummary get()
          Method to get the singleton object
protected  java.io.File getActiveFile()
          Gets the ActiveFile attribute of the CurrentSummary object
 Summary getCurrentSummary()
          Gets the CurrentSummary attribute of the CurrentSummary object
protected  int getLineNumber()
          Returns the initial line number
protected abstract  MultipleDirClassDiagramReloader getMetadataReloader()
          Gets the reloader
 void insertUpdate(javax.swing.event.DocumentEvent evt)
          Method that receives notification when the editor changes
static void register(CurrentSummary value)
          Register the current summary
protected abstract  void registerWithCurrentDocument()
          Register with the current document
 void removeUpdate(javax.swing.event.DocumentEvent evt)
          Method that receives notification when the editor changes
 void reset()
          Description of the Method
 void updateMetaData()
          Reloads all the metadata before attempting to perform a refactoring.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

lineNo

public int lineNo

upToDate

protected boolean upToDate
Has this file changed since the last time this was invoked

Constructor Detail

CurrentSummary

protected CurrentSummary()
Constructor for the CurrentSummary object

Method Detail

get

public static CurrentSummary get()
Method to get the singleton object

Returns:
the current summary

getActiveFile

protected java.io.File getActiveFile()
Gets the ActiveFile attribute of the CurrentSummary object

Returns:
The ActiveFile value

getCurrentSummary

public Summary getCurrentSummary()
Gets the CurrentSummary attribute of the CurrentSummary object

Returns:
The CurrentSummary value

getLineNumber

protected int getLineNumber()
Returns the initial line number

Returns:
The LineNumber value

getMetadataReloader

protected abstract MultipleDirClassDiagramReloader getMetadataReloader()
Gets the reloader

Returns:
The MetadataReloader value

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent evt)
Method that receives notification when the editor changes

Specified by:
changedUpdate in interface javax.swing.event.DocumentListener
Parameters:
evt - Description of Parameter

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent evt)
Method that receives notification when the editor changes

Specified by:
insertUpdate in interface javax.swing.event.DocumentListener
Parameters:
evt - Description of Parameter

register

public static void register(CurrentSummary value)
Register the current summary

Parameters:
value - Description of Parameter

registerWithCurrentDocument

protected abstract void registerWithCurrentDocument()
Register with the current document


removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent evt)
Method that receives notification when the editor changes

Specified by:
removeUpdate in interface javax.swing.event.DocumentListener
Parameters:
evt - Description of Parameter

reset

public void reset()
Description of the Method


updateMetaData

public void updateMetaData()
Reloads all the metadata before attempting to perform a refactoring.