org.eclipse.ui.editors.text

Interface IStorageDocumentProvider

All Known Implementing Classes:

FileDocumentProvider, ForwardingDocumentProvider, StorageDocumentProvider, TextFileDocumentProvider, TextFileDocumentProvider.NullProvider

public interface IStorageDocumentProvider

Document provider for IStorage based domain elements. Basically incorporates the concept of character encoding.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultEncoding() Returns the default character encoding used by this provider.
java.lang.String	getEncoding(java.lang.Object element) Returns the character encoding for the given element, or null if the element is not managed by this provider.
void	setEncoding(java.lang.Object element, java.lang.String encoding) Sets the encoding for the given element.

Method Detail

getDefaultEncoding

java.lang.String getDefaultEncoding()

Returns the default character encoding used by this provider.

Returns:

the default character encoding used by this provider

getEncoding

java.lang.String getEncoding(java.lang.Object element)

Returns the character encoding for the given element, or null if the element is not managed by this provider.

Parameters:

element - the element

Returns:

the encoding for the given element

setEncoding

void setEncoding(java.lang.Object element,
                 java.lang.String encoding)

Sets the encoding for the given element. If encoding is null the workbench's character encoding should be used.

Parameters:

element - the element

encoding - the encoding to be used