Eclipse Plug-in Developer Guide (Galileo) - TextSelection (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.text
Class TextSelection


java.lang.Object
  
org.eclipse.jface.text.TextSelection

All Implemented Interfaces:: ITextSelection, ISelection

Direct Known Subclasses:: BlockTextSelection

public class TextSelection
extends Object
implements ITextSelection
extends Object
implements ITextSelection

Standard implementation of ITextSelection.

Takes advantage of the weak contract of correctness of its interface. If generated from a selection provider, it only remembers its offset and length and computes the remaining information on request.

Constructor Summary

TextSelection ( IDocument document, int offset, int length)
          Creates a text selection for the given range of the given document.

TextSelection (int offset, int length)
          Creates a text selection for the given range.

Method Summary

static ITextSelection emptySelection ()
          Returns the shared instance of the empty text selection.

boolean equals ( Object obj)


protected IDocument getDocument ()
          Returns the document underlying the receiver, possibly null.

int getEndLine ()
          Returns the number of the line containing the last character of the selected text.

int getLength ()
          Returns the length of the selected text.

int getOffset ()
          Returns the offset of the selected text.

int getStartLine ()
          Returns number of the line containing the offset of the selected text.

String getText ()
          Returns the selected text.

int hashCode ()


boolean isEmpty ()
          Tells whether this text selection is the empty selection.

Methods inherited from class java.lang. Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextSelection

public TextSelection(int offset,
                     int length)

Creates a text selection for the given range. This selection object describes generically a text range and is intended to be an argument for the setSelection method of selection providers.

Parameters:: offset - the offset of the range, must not be negative; length - the length of the range, must not be negative

TextSelection

public TextSelection(
IDocument document,
                     int offset,
                     int length)

Creates a text selection for the given range of the given document. This selection object is created by selection providers in responds getSelection.

Parameters:: document - the document whose text range is selected in a viewer; offset - the offset of the selected range, must not be negative; length - the length of the selected range, must not be negative

Method Detail

emptySelection

public static 
ITextSelection emptySelection()

Returns the shared instance of the empty text selection.

Returns:: the shared instance of an empty text selection

isEmpty

public boolean isEmpty()

Tells whether this text selection is the empty selection.

A selection of length 0 is not an empty text selection as it describes, e.g., the cursor position in a viewer.

Specified by:: isEmpty in interface ISelection

Returns:: true if this selection is empty
See Also:: emptySelection()