|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface ITextFileBufferManager
A text file buffer manager manages text file buffers for files whose contents is considered text.
Clients are not supposed to implement that interface.
| Method Summary | |
|---|---|
IAnnotationModel |
createAnnotationModel(IPath location)
Creates a new annotation for the given location. |
IDocument |
createEmptyDocument(IPath location)
Creates a new empty document. |
String |
getDefaultEncoding()
Returns the default encoding that is used to read the contents of text files if no other encoding is specified. |
ITextFileBuffer |
getTextFileBuffer(IPath location)
Returns the text file buffer managed for the file at the given location or null if either there is no such text file buffer. |
boolean |
isTextFileLocation(IPath location)
Deprecated. As of 3.2, replaced by isTextFileLocation(IPath, boolean) |
boolean |
isTextFileLocation(IPath location,
boolean strict)
Returns whether a file at the given location is or can be considered a text file. |
| Methods inherited from interface org.eclipse.core.filebuffers.IFileBufferManager |
|---|
addFileBufferListener, connect, disconnect, getFileBuffer, releaseSynchronizationContext, removeFileBufferListener, requestSynchronizationContext, setSynchronizationContext, validateState |
| Method Detail |
|---|
ITextFileBuffer getTextFileBuffer(IPath location)
null if either there is no such text file buffer.
The provided location is either a full path of a workspace resource or an absolute path in the local file system. The file buffer manager does not resolve the location of workspace resources in the case of linked resources.
location - the location
nullString getDefaultEncoding()
IDocument createEmptyDocument(IPath location)
The provided location is either a full path of a workspace resource or an absolute path in the local file system. The file buffer manager does not resolve the location of workspace resources in the case of linked resources.
location - the location used to set up the newly created document
IAnnotationModel createAnnotationModel(IPath location)
The provided location is either a full path of a workspace resource or an absolute path in the local file system. The file buffer manager does not resolve the location of workspace resources in the case of linked resources.
location - the location used to create the new annotation model
boolean isTextFileLocation(IPath location)
isTextFileLocation(IPath, boolean)
true. If the file does
not exist, it is checked whether a text content type is associated with
the given location. If no content type is associated with the location,
this method returns true.
The provided location is either a full path of a workspace resource or an absolute path in the local file system. The file buffer manager does not resolve the location of workspace resources in the case of linked resources.
location - the location to check
true if the location is a text file location
boolean isTextFileLocation(IPath location,
boolean strict)
!strict. If the file does
not exist, it is checked whether a text content type is associated with
the given location. If no content type is associated with the location,
this method returns !strict.
The provided location is either a full path of a workspace resource or an absolute path in the local file system. The file buffer manager does not resolve the location of workspace resources in the case of linked resources.
location - the location to checkstrict - true if a file with unknown content type
is not treated as text file, false otherwise
true if the location is a text file location
|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.