Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

de.hunsicker.jalopy.plugin
Interface ProjectFile  view ProjectFile download ProjectFile.java


public interface ProjectFile

Represents a Java source file that is part of a project.

Version:
$Revision: 1.2 $

Method Summary
 Editor getEditor()
          Returns an editor view to modify the file.
 java.lang.String getEncoding()
          Returns the encoding used to read and write this file.
 java.io.File getFile()
          Returns the underlying physical file.
 java.lang.String getName()
          Returns the name of the file.
 Project getProject()
          Returns the project this file is attached to.
 boolean isOpened()
          Determines whether the file is currently opened.
 boolean isReadOnly()
          Determines whether the file can be changed.
 

Method Detail

getEditor

public Editor getEditor()
Returns an editor view to modify the file. One may check if the file is actually opened in the editor prior to call this method:
 if (projectFile.isOpened())
 {
     return projectFile.getEditor();
 }
 else
 {
     // do whatever you want ...
 }
 


getEncoding

public java.lang.String getEncoding()
Returns the encoding used to read and write this file.


getFile

public java.io.File getFile()
Returns the underlying physical file. Note that if the application uses virtual files this method should create an intermediate representation but never return null.


getName

public java.lang.String getName()
Returns the name of the file.


isOpened

public boolean isOpened()
Determines whether the file is currently opened. That means an editor view exists.


getProject

public Project getProject()
Returns the project this file is attached to.


isReadOnly

public boolean isReadOnly()
Determines whether the file can be changed.