Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.jface.text
Interface IDocumentPartitionerExtension3

All Known Implementing Classes:
DefaultPartitioner, FastPartitioner

public interface IDocumentPartitionerExtension3

Extension interface for IDocumentPartitioner. Adds the concept of rewrite sessions. A rewrite session is a sequence of replace operations that form a semantic unit.

Since:
3.1

Method Summary
 void connect ( IDocument document, boolean delayInitialization)
          Connects this partitioner to a document.
  DocumentRewriteSession getActiveRewriteSession ()
          Returns the active rewrite session of this document or null.
 void startRewriteSession ( DocumentRewriteSession session)
          Tells the document partitioner that a rewrite session started.
 void stopRewriteSession ( DocumentRewriteSession session)
          Tells the document partitioner that the rewrite session has finished.
 

Method Detail

startRewriteSession

void startRewriteSession(
DocumentRewriteSession session)
                         throws 
IllegalStateException
Tells the document partitioner that a rewrite session started. A rewrite session is a sequence of replace operations that form a semantic unit. The document partitioner is allowed to use that information for internal optimization.

Parameters:
session - the rewrite session
Throws:
IllegalStateException - in case there is already an active rewrite session

stopRewriteSession

void stopRewriteSession(
DocumentRewriteSession session)
Tells the document partitioner that the rewrite session has finished. This method is only called when startRewriteSession has been called before.

Parameters:
session - the rewrite session

getActiveRewriteSession

DocumentRewriteSession getActiveRewriteSession()
Returns the active rewrite session of this document or null.

Returns:
the active rewrite session or null

connect

void connect(
IDocument document,
             boolean delayInitialization)
Connects this partitioner to a document. Connect indicates the begin of the usage of the receiver as partitioner of the given document. Thus, resources the partitioner needs to be operational for this document should be allocated.

The caller of this method must ensure that this partitioner is also set as the document's document partitioner.

delayInitialization indicates whether the partitioner is allowed to delay it initial computation of the document's partitioning until it has to answer the first query. Replaces IDocumentPartitioner.connect(IDocument).

Parameters:
document - the document to be connected to
delayInitialization - true if initialization can be delayed, false otherwise

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire