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.source.projection
Interface IProjectionPosition


public interface IProjectionPosition

An IProjectionPosition is a position that is associated with a ProjectionAnnotation and that is able to compute its collapsed regions. That is, if a Position implements this interface, ProjectionViewer will delegate to the computeProjectionRegions method when determining the document regions that should be collapsed for a certain ProjectionAnnotation.

Since:
3.1

Method Summary
 int computeCaptionOffset ( IDocument document)
          Returns the offset of the caption (the anchor region) of this projection position.
  IRegion[] computeProjectionRegions ( IDocument document)
          Returns an array of regions that should be collapsed when the annotation belonging to this position is collapsed.
 

Method Detail

computeProjectionRegions

IRegion[] computeProjectionRegions(
IDocument document)
                                   throws 
BadLocationException
Returns an array of regions that should be collapsed when the annotation belonging to this position is collapsed. May return null instead of an empty array.

Parameters:
document - the document that this position is attached to
Returns:
the foldable regions for this position
Throws:
BadLocationException - if accessing the document fails

computeCaptionOffset

int computeCaptionOffset(
IDocument document)
                         throws 
BadLocationException
Returns the offset of the caption (the anchor region) of this projection position. The returned offset is relative to the receivers offset into the document.

Parameters:
document - the document that this position is attached to
Returns:
the caption offset relative to the position's offset
Throws:
BadLocationException - if accessing the document fails

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