edu.rice.cs.util.docnavigation
Interface INavigatorItem

All Known Subinterfaces:

OpenDefinitionsDocument

All Known Implementing Classes:

DummyOpenDefDoc

public interface INavigatorItem

INavigatorItem models (very abstractly) some entity that is eligible for insertion and removal inside an IDocumentNavigator. Conceptually, if an IDocumentNavigator represented a file cabinet then each file in the cabinet would be an INavigatorItem. If an IDocumentNavigator represented a wallet then each credit card and driver's license would be an INavigatorItem.

The only real responsibilities a class implementing INavigatorItem has is to provide a simple String representation of itself via the getName method and to devise some notion of equality.

Method Summary

boolean	checkIfClassFileInSync()
boolean	fileExists()
String	getName() Returns a "simple" name representing this INavigatorItem.
boolean	inProject()
boolean	isAuxiliaryFile()
boolean	isUntitled()

Method Detail

checkIfClassFileInSync

boolean checkIfClassFileInSync()

fileExists

boolean fileExists()

getName

String getName()

Returns a "simple" name representing this INavigatorItem. Strings returned by this method may or may not be unique with respect to other INavigatorItems within or without a given IDocumentNavigator.

Returns:

the simple name for this document.

isAuxiliaryFile

boolean isAuxiliaryFile()

inProject

boolean inProject()

isUntitled

boolean isUntitled()