Package org.eclipse.jface.text
Class BlockTextSelection
- java.lang.Object
-
- org.eclipse.jface.text.TextSelection
-
- org.eclipse.jface.text.BlockTextSelection
-
- All Implemented Interfaces:
IBlockTextSelection,ITextSelection,ISelection
public class BlockTextSelection extends TextSelection implements IBlockTextSelection
Standard implementation ofIBlockTextSelection.- Since:
- 3.5
-
-
Constructor Summary
Constructors Constructor Description BlockTextSelection(IDocument document, int startLine, int startColumn, int endLine, int endColumn, int tabWidth)Creates a column selection for the given lines and columns.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)intgetEndColumn()Returns the exclusive column on the end line at which the selection ends.intgetEndLine()Returns the number of the line containing the last character of the selected text.IRegion[]getRegions()Returns a non-empty array containing the selected text range for each line covered by the selection.intgetStartColumn()Returns the column on the start line at which the selection starts.intgetStartLine()Returns number of the line containing the offset of the selected text.StringgetText()Returns the selected text.inthashCode()StringtoString()-
Methods inherited from class org.eclipse.jface.text.TextSelection
emptySelection, getDocument, getLength, getOffset, isEmpty
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.jface.viewers.ISelection
isEmpty
-
Methods inherited from interface org.eclipse.jface.text.ITextSelection
getLength, getOffset
-
-
-
-
Constructor Detail
-
BlockTextSelection
public BlockTextSelection(IDocument document, int startLine, int startColumn, int endLine, int endColumn, int tabWidth)
Creates a column selection for the given lines and columns.- Parameters:
document- the document that this selection refers tostartLine- the start linestartColumn- the possibly virtual start column, measured in characters from the start ofstartLineendLine- the inclusive end lineendColumn- the exclusive and possibly virtual end column, measured in characters from the start ofendLinetabWidth- the tabulator width used to compute the visual offsets from character offsets
-
-
Method Detail
-
getStartLine
public int getStartLine()
Description copied from interface:ITextSelectionReturns number of the line containing the offset of the selected text. If the underlying text has been changed between the creation of this selection object and the call of this method, the value returned might differ from what it would have been at the point of creation.- Specified by:
getStartLinein interfaceITextSelection- Overrides:
getStartLinein classTextSelection- Returns:
- the start line of this selection or -1 if there is no valid line information
-
getStartColumn
public int getStartColumn()
Description copied from interface:IBlockTextSelectionReturns the column on the start line at which the selection starts. The returned column is a character count measured from the start of the line. It may be larger than the length of the line, in which case it is a virtual offset.- Specified by:
getStartColumnin interfaceIBlockTextSelection- Returns:
- the start column measured from the line start
-
getEndLine
public int getEndLine()
Description copied from interface:ITextSelectionReturns the number of the line containing the last character of the selected text. If the underlying text has been changed between the creation of this selection object and the call of this method, the value returned might differ from what it would have been at the point of creation.- Specified by:
getEndLinein interfaceITextSelection- Overrides:
getEndLinein classTextSelection- Returns:
- the end line of this selection or -1 if there is no valid line information
-
getEndColumn
public int getEndColumn()
Description copied from interface:IBlockTextSelectionReturns the exclusive column on the end line at which the selection ends. The returned column is a character count measured from the start of the line. It may be larger than the length of the line, in which case it is a virtual offset.- Specified by:
getEndColumnin interfaceIBlockTextSelection- Returns:
- the end column measured from the line start
-
getText
public String getText()
Description copied from interface:ITextSelectionReturns the selected text. If the underlying text has been changed between the creation of this selection object and the call of this method, the value returned might differ from what it would have been at the point of creation.- Specified by:
getTextin interfaceIBlockTextSelection- Specified by:
getTextin interfaceITextSelection- Overrides:
getTextin classTextSelection- Returns:
- the selected text or
nullif there is no valid text information - See Also:
ITextSelection.getText()
-
hashCode
public int hashCode()
- Overrides:
hashCodein classTextSelection
-
equals
public boolean equals(Object obj)
- Overrides:
equalsin classTextSelection
-
getRegions
public IRegion[] getRegions()
Description copied from interface:IBlockTextSelectionReturns a non-empty array containing the selected text range for each line covered by the selection.- Specified by:
getRegionsin interfaceIBlockTextSelection- Returns:
- an array containing a the covered text range for each line covered by the receiver
-
toString
public String toString()
- Overrides:
toStringin classTextSelection- Since:
- 3.16
-
-