Examples of org.eclipse.jface.text.IDocument

org.eclipse.jface.text.IDocument
An IDocument represents text providing support for
- text manipulation
- positions
- partitions
- line information
- document change listeners
- document partition change listeners
A document allows to set its content and to manipulate it. For manipulation a document provides the replace method which substitutes a given string for a specified text range in the document. On each document change, all registered document listeners are informed exactly once.
Positions are stickers to the document's text that are updated when the document is changed. Positions are updated by {@link org.eclipse.jface.text.IPositionUpdater}s. Position updaters are managed as a list. The list defines the sequence in which position updaters are invoked. This way, position updaters may rely on each other. Positions are grouped into categories. A category is a ordered list of positions. the document defines the order of position in a category based on the position's offset based on the implementation of the method computeIndexInCategory. Each document must support a default position category whose name is specified by this interface.

A document can be considered consisting of a sequence of not overlapping partitions. A partition is defined by its offset, its length, and its type. Partitions are updated on every document manipulation and ensured to be up-to-date when the document listeners are informed. A document uses an IDocumentPartitioner to manage its partitions. A document may be unpartitioned which happens when there is no partitioner. In this case, the document is considered as one single partition of a default type. The default type is specified by this interface. If a document change changes the document's partitioning all registered partitioning listeners are informed exactly once. The extension interface {@link org.eclipse.jface.text.IDocumentExtension3}introduced in version 3.0 extends the concept of partitions and allows a document to not only manage one but multiple partitioning. Each partitioning has an id which must be used to refer to a particular partitioning.

An IDocument provides methods to map line numbers and character positions onto each other based on the document's line delimiters. When moving text between documents using different line delimiters, the text must be converted to use the target document's line delimiters.

An IDocument does not care about mixed line delimiters. Clients who want to ensure a single line delimiter in their document should use the line delimiter returned by {@link org.eclipse.jface.text.TextUtilities#getDefaultLineDelimiter(IDocument)}.

IDocument throws BadLocationException if the parameters of queries or manipulation requests are not inside the bounds of the document. The purpose of this style of exception handling is
- prepare document for multi-thread access
- allow clients to implement backtracking recovery methods
- prevent clients from up-front contract checking when dealing with documents.
A document support for searching has deprecated since version 3.0. The recommended way for searching is to use a {@link org.eclipse.jface.text.FindReplaceDocumentAdapter}.

In order to provide backward compatibility for clients of IDocument, extension interfaces are used to provide a means of evolution. The following extension interfaces exist:
- {@link org.eclipse.jface.text.IDocumentExtension} since version 2.0 introducing the conceptof post notification replaces in order to allow document listeners to manipulate the document while receiving a document change notification
- {@link org.eclipse.jface.text.IDocumentExtension2} since version 2.1 introducing configurationmethods for post notification replaces and document change notification.
- {@link org.eclipse.jface.text.IDocumentExtension3} since version 3.0 replacing the originalpartitioning concept by allowing multiple partitionings at the same time and introducing zero- length partitions in conjunction with the distinction between open and closed partitions.
- {@link org.eclipse.jface.text.IDocumentExtension4} since version 3.1 introducing theconcept of rewrite sessions. A rewrite session is a sequence of document replace operations that form a semantic unit. It also introduces a modification stamp and the ability to set the initial line delimiter and to query the default line delimiter.
Clients may implement this interface and its extension interfaces or use the default implementation provided by AbstractDocument and Document.
@see org.eclipse.jface.text.IDocumentExtension @see org.eclipse.jface.text.IDocumentExtension2 @see org.eclipse.jface.text.IDocumentExtension3 @see org.eclipse.jface.text.IDocumentExtension4 @see org.eclipse.jface.text.Position @see org.eclipse.jface.text.IPositionUpdater @see org.eclipse.jface.text.IDocumentPartitioner @see org.eclipse.jface.text.ILineTracker @see org.eclipse.jface.text.IDocumentListener @see org.eclipse.jface.text.IDocumentPartitioningListener

     * @see IStructureCreator#save
     */
    @Override
    public void save(final IStructureComparator structure, final Object input) {
        if (input instanceof IEditableContent && structure instanceof ErlNode) {
            final IDocument doc = ((ErlNode) structure).getDocument();
            final IEditableContent bca = (IEditableContent) input;
            final String c = doc.get();
            bca.setContent(c.getBytes());
        }
    }

View Full Code Here

            final ISharedDocumentAdapter sharedDocumentAdapter,
            final IProgressMonitor monitor) throws CoreException {
        IErlModule module = null;
        final IErlModel model = ErlangEngine.getInstance().getModel();
        String s = "";
        IDocument document = document0;
        if (element instanceof ResourceNode) {
            final ResourceNode rn = (ResourceNode) element;
            final IResource r = rn.getResource();
            if (r instanceof IFile) {
                final IFile f = (IFile) r;
                final IErlElement e = model.findElement(r);
                if (e instanceof IErlModule) {
                    module = (IErlModule) e;
                }
                if (document == null) {
                    try {
                        s = readString(f.getContents());
                        document = new Document(s);
                    } catch (final CoreException e1) {
                    }
                }
            }
        } else if (document == null && element instanceof IStreamContentAccessor) {
            try {
                final InputStream contents = ((IStreamContentAccessor) element)
                        .getContents();
                try {
                    s = readString(contents);
                } finally {
                    try {
                        contents.close();
                    } catch (final IOException e) {
                    }
                }
                document = new Document(s);
            } catch (final CoreException ex) {
            }
        } else if (document != null) {
            s = document.get();
        }
        if (module == null) {
            String name = "comptemp";
            if (element instanceof ITypedElement) {
                final ITypedElement typedElement = (ITypedElement) element;

View Full Code Here

        }
        return result;
    }


    public void addMessage(final int offset, final String message) {
        final IDocument document = editor.getDocumentProvider().getDocument(
                editor.getEditorInput());
        try {
            final String delimiter = document.getLineDelimiter(document
                    .getLineOfOffset(offset - 1));
            String nl = "";
            if (delimiter == null) {
                if (document instanceof IDocumentExtension4) {
                    final IDocumentExtension4 documentExtension4 = (IDocumentExtension4) document;
                    nl = documentExtension4.getDefaultLineDelimiter();
                } else {
                    final String[] delimiters = document.getLegalLineDelimiters();
                    nl = delimiters[0];
                }
            }
            final Display display = ErlideUIPlugin.getStandardDisplay();
            final String addMessage = nl + message;
            display.asyncExec(new Runnable() {


                @Override
                public void run() {
                    try {
                        document.replace(offset, 0, addMessage);
                    } catch (final BadLocationException e) {
                    }
                }
            });
            ErlLogger.debug("message %s", message);

View Full Code Here

    }


    protected ITextSelection getLineSelection(final ITextSelection selection0,
            final boolean beginningOfNextLine) {
        ITextSelection selection = selection0;
        final IDocument document = editor.getDocumentProvider().getDocument(
                editor.getEditorInput());
        if (selection.getLength() == 0) { // don't use isEmpty()!
            selection = ErlangAbstractHandler.extendSelectionToWholeLines(document,
                    selection);
        }
        if (beginningOfNextLine) {
            final int endLine = selection.getEndLine();
            int offset;
            try {
                offset = document.getLineOffset(endLine)
                        + document.getLineLength(endLine);
                selection = new TextSelection(offset, 0);
            } catch (final BadLocationException e) {
                offset = document.getLength();
            }
        }
        return selection;
    }

View Full Code Here


        if (region == null || textViewer == null) {
            return null;
        }


        final IDocument document = textViewer.getDocument();
        final int offset = region.getOffset();


        if (document == null) {
            return null;
        }


        IRegion lineInfo;
        String line;
        try {
            lineInfo = document.getLineInformationOfOffset(offset);
            line = document.get(lineInfo.getOffset(), lineInfo.getLength());
        } catch (final BadLocationException ex) {
            return null;
        }
        final int offsetInLine = offset - lineInfo.getOffset();

View Full Code Here

                }
                // when entering an anonymous class between the parenthesis', we
                // don't want to jump after the closing parenthesis when return
                // is pressed
                if (event.character == SWT.CR && offset > 0) {
                    final IDocument document = sourceViewer.getDocument();
                    try {
                        if (document.getChar(offset - 1) == '{') {
                            return new ExitFlags(ILinkedModeListener.EXIT_ALL, true);
                        }
                    } catch (final BadLocationException e) {
                    }
                }

View Full Code Here

            return null;
        }


        @SuppressWarnings("synthetic-access")
        private boolean isMasked(final int offset) {
            final IDocument document = sourceViewer.getDocument();
            try {
                return fEscapeCharacter == document.getChar(offset - 1);
            } catch (final BadLocationException e) {
            }
            return false;
        }

View Full Code Here


        if (module == null || selection == null) {
            return;
        }


        final IDocument document = editor.getViewer().getDocument();
        if (document == null) {
            return;
        }


        boolean hasChanged = false;

View Full Code Here


    @Override
    protected TemplateContext createContext(final ITextViewer viewer, final IRegion region) {
        final TemplateContextType contextType = getContextType(viewer, region);
        if (contextType instanceof ErlangTemplateContextType) {
            final IDocument document = viewer.getDocument();
            return new ErlangTemplateContext(contextType, document, region.getOffset(),
                    region.getLength());
        }
        return super.createContext(viewer, region);
    }

View Full Code Here

            final ITextViewer textViewer = editor.getViewer();
            if (textViewer == null) {
                return Status.CANCEL_STATUS;
            }


            final IDocument document = textViewer.getDocument();
            if (document == null) {
                return Status.CANCEL_STATUS;
            }


            final IDocumentProvider documentProvider = editor.getDocumentProvider();

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.eclipse.jface.text.IDocument

at.ssw.coco.ide.features.semanticHighlighting.SemanticHighlightingPresenter

bndtools.editor.BndEditor

bndtools.editor.pages.ApplyCompletionProposalAction

com.dubture.composer.ui.editor.composer.ComposerFormEditor

com.github.elucash.lambda4jdt.FoldingStructureProvider

com.github.elucash.lambda4jdt.JavaStyleClosuresFoldingProvider

com.googlecode.goclipse.editors.DoubleClickStrategy

com.googlecode.goclipse.editors.GoEditorOutlinePage

com.googlecode.lambda4jdt.CutomizedJavaFoldingStructureProvider

com.googlecode.lambda4jdt.JavaStyleClosuresFoldingProvider

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.