Examples of org.eclipse.ui.texteditor.IDocumentProvider

org.eclipse.ui.texteditor.IDocumentProvider
A document provider maps between domain elements and documents. A document provider has the following responsibilities:
- create an annotation model of a domain model element
- create and manage a textual representation, i.e., a document, of a domain model element
- create and save the content of domain model elements based on given documents
- update the documents this document provider manages for domain model elements to changes directly applied to those domain model elements
- notify all element state listeners about changes directly applied to domain model elements this document provider manages a document for, i.e. the document provider must know which changes of a domain model element are to be interpreted as element moves, deletes, etc.
Text editors use document providers to bridge the gap between their input elements and the documents they work on. A single document provider may be shared between multiple editors; the methods take the editors' input elements as a parameter.
This interface may be implemented by clients; or subclass the standard abstract base class AbstractDocumentProvider.

In order to provided backward compatibility for clients of IDocumentProvider, extension interfaces are used to provide a means of evolution. The following extension interfaces exist:
- {@link org.eclipse.ui.texteditor.IDocumentProviderExtension} since version 2.0 introducingstate validation, extended read-only handling and synchronization.
- {@link org.eclipse.ui.texteditor.IDocumentProviderExtension2} since version 2.1 introducingadding support for a global progress monitor.
- {@link org.eclipse.ui.texteditor.IDocumentProviderExtension3} since version 3.0 addinga predicate for querying synchronization state.
- {@link org.eclipse.ui.texteditor.IDocumentProviderExtension4} since version 3.1 addinga predicate for querying an element's the content description.
- {@link org.eclipse.ui.texteditor.IDocumentProviderExtension5} since version 3.2 addingthe ability to detect a non-synchronized exception.
@see org.eclipse.jface.text.IDocument @see org.eclipse.ui.texteditor.AbstractDocumentProvider @see org.eclipse.ui.texteditor.IDocumentProviderExtension @see org.eclipse.ui.texteditor.IDocumentProviderExtension2 @see org.eclipse.ui.texteditor.IDocumentProviderExtension3 @see org.eclipse.ui.texteditor.IDocumentProviderExtension4 @see org.eclipse.ui.texteditor.IDocumentProviderExtension5

  /**
   * @see org.eclipse.ui.texteditor.AbstractDocumentProvider#doSaveDocument(org.eclipse.core.runtime.IProgressMonitor,
   *      java.lang.Object, org.eclipse.jface.text.IDocument, boolean)
   */
  protected void doSaveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite) throws CoreException {
    IDocumentProvider provider = null;
    // BUG119211 - try to use registered document provider if possible
    if (element instanceof IEditorInput) {
      provider = DocumentProviderRegistry.getDefault().getDocumentProvider((IEditorInput) element);
    }
    if (provider == null)
      provider = new FileDocumentProvider();
    provider.saveDocument(monitor, element, document, overwrite);
  }

View Full Code Here

   *             getExistingModelFor*(IDocument). Supported document
   *             providers ensure that the document maps to a shared
   *             structured model.
   */
  public IStructuredModel getModel() {
    IDocumentProvider documentProvider = getDocumentProvider();
    
    if (documentProvider == null) {
      // this indicated an error in startup sequence
      Logger.trace(getClass().getName(), "Program Info Only: document provider was null when model requested"); //$NON-NLS-1$ //$NON-NLS-2$
    }
    
    // Remember if we entered this method without a model existing
    boolean initialModelNull = (fStructuredModel == null);
    
    if (fStructuredModel == null && documentProvider != null) {
      // lazily set the model instance, although this is an ABNORMAL
      // CODE PATH
      if (documentProvider instanceof IModelProvider) {
        fStructuredModel = ((IModelProvider) documentProvider).getModel(getEditorInput());
        fisReleased = false;
      }
      else {
        IDocument doc = documentProvider.getDocument(getEditorInput());
        if (doc instanceof IStructuredDocument) {
          /*
           * Called in this manner because getExistingModel can skip
           * some calculations always performed in getModelForEdit
           */

View Full Code Here


  protected String getContentType(IDocument document) {
    IModelManager mgr = StructuredModelManager.getModelManager();
    String contentType = null;


    IDocumentProvider provider = fTextEditor.getDocumentProvider();
    if (provider instanceof IDocumentProviderExtension4) {
      try {
        IContentType type = ((IDocumentProviderExtension4) provider).getContentType(fTextEditor.getEditorInput());
        if (type != null)
          contentType = type.getId();

View Full Code Here

   * editor's input.
   * 
   * @return the marker annotation model
   */
  protected AbstractMarkerAnnotationModel getAnnotationModel() {
    IDocumentProvider provider = fTextEditor.getDocumentProvider();
    IAnnotationModel model = provider.getAnnotationModel(fTextEditor.getEditorInput());
    if (model instanceof AbstractMarkerAnnotationModel)
      return (AbstractMarkerAnnotationModel) model;
    return null;
  }

View Full Code Here

   * Returns the <code>IDocument</code> of the editor's input.
   * 
   * @return the document of the editor's input
   */
  protected IDocument getDocument() {
    IDocumentProvider provider = fTextEditor.getDocumentProvider();
    return provider.getDocument(fTextEditor.getEditorInput());
  }

View Full Code Here

          IType tp = findType;
          IEditorPart editorPart = EditorUtility.openInEditor(tp);
          IEditorInput editorInput = editorPart.getEditorInput();
          if (editorPart instanceof ITextEditor && lineNumber >= 0) {
            ITextEditor textEditor = (ITextEditor) editorPart;
            IDocumentProvider provider = textEditor
                .getDocumentProvider();
            provider.connect(editorInput);
            IDocument document = null;
            document = provider.getDocument(editorInput);
            try {
              IRegion line = document
                  .getLineInformation(lineNumber - 1);
              textEditor.selectAndReveal(line.getOffset(), line
                  .getLength());
            } catch (BadLocationException e) {
            }
            provider.disconnect(editorInput);
          }
        }
      } catch (JavaModelException e) {
        Activator.getDefault().log(e);
      } catch (CoreException e) {

View Full Code Here

    private IStructuredModel getStructuredModel() {
      IStructuredModel model = null;
      if (_structuredModel != null) {
        model = _structuredModel;
      } else {
      IDocumentProvider provider = getDocumentProvider();
      if (provider != null) {
        IDocument document = provider.getDocument(getEditorInput());
        _structuredModel = StructuredModelManager.getModelManager().getExistingModelForRead(document);
        model = _structuredModel;
      }
      }
    return model;

View Full Code Here

  /**
   * @see org.eclipse.ui.texteditor.AbstractDocumentProvider#doSaveDocument(org.eclipse.core.runtime.IProgressMonitor,
   *      java.lang.Object, org.eclipse.jface.text.IDocument, boolean)
   */
  protected void doSaveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite) throws CoreException {
    IDocumentProvider provider = null;
    // BUG119211 - try to use registered document provider if possible
    if (element instanceof IEditorInput) {
      provider = DocumentProviderRegistry.getDefault().getDocumentProvider((IEditorInput) element);
    }
    if (provider == null)
      provider = new FileDocumentProvider();
    provider.saveDocument(monitor, element, document, overwrite);
  }

View Full Code Here

   * editor's input.
   * 
   * @return the marker annotation model
   */
  protected AbstractMarkerAnnotationModel getAnnotationModel() {
    IDocumentProvider provider = fTextEditor.getDocumentProvider();
    IAnnotationModel model = provider.getAnnotationModel(fTextEditor.getEditorInput());
    if (model instanceof AbstractMarkerAnnotationModel)
      return (AbstractMarkerAnnotationModel) model;
    return null;
  }

View Full Code Here

   * Returns the <code>IDocument</code> of the editor's input.
   * 
   * @return the document of the editor's input
   */
  protected IDocument getDocument() {
    IDocumentProvider provider = fTextEditor.getDocumentProvider();
    return provider.getDocument(fTextEditor.getEditorInput());
  }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.eclipse.ui.texteditor.IDocumentProvider

at.bestsolution.efxclipse.tooling.jdt.ui.internal.editors.outline.PropertyContentOutlinePage

bndtools.editor.BndEditor

bndtools.editor.BndSourceEditorPage

com.cb.eclipse.folding.java.EnhancedJavaFoldingStructureProvider

com.cb.eclipse.folding.java.EnhancedJavaFoldingStructureProvider$ElementChangedListener

com.dubture.symfony.ui.actions.BaseTextInsertionHandler

com.dubture.twig.ui.editor.folding.StructuredTextFoldingProviderTwig

com.dubture.twig.ui.editor.TwigStructuredEditor

com.dubture.twig.ui.editor.TwigStructuredEditor$OccurrencesFinderJob

com.dubture.twig.ui.editor.TwigStructuredEditor$OccurrencesFinderJobCanceler

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.