Eclipse Platform
Release 3.4

org.eclipse.ui.texteditor
Class TextViewerDeleteLineTarget

java.lang.Object
  extended byorg.eclipse.ui.texteditor.TextViewerDeleteLineTarget
All Implemented Interfaces:
org.eclipse.ui.texteditor.IDeleteLineTarget

public class TextViewerDeleteLineTarget
extends Object
implements org.eclipse.ui.texteditor.IDeleteLineTarget

A delete line target.

Since:
3.4

Constructor Summary
TextViewerDeleteLineTarget(ITextViewer viewer)
          Creates a new target.
 
Method Summary
 void deleteLine(IDocument document, int offset, int length, int type, boolean copyToClipboard)
          Deletes the specified fraction of the line of the given offset.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TextViewerDeleteLineTarget

public TextViewerDeleteLineTarget(ITextViewer viewer)
Creates a new target.

Parameters:
viewer - the viewer that the new target operates on
Method Detail

deleteLine

public void deleteLine(IDocument document,
                       int offset,
                       int length,
                       int type,
                       boolean copyToClipboard)
                throws BadLocationException
Description copied from interface: org.eclipse.ui.texteditor.IDeleteLineTarget
Deletes the specified fraction of the line of the given offset.

Specified by:
deleteLine in interface org.eclipse.ui.texteditor.IDeleteLineTarget
Parameters:
document - the document
offset - the offset
length - the length
type - the line deletion type, must be one of WHOLE_LINE, TO_BEGINNING or TO_END
copyToClipboard - true if the deleted line should be copied to the clipboard
Throws:
BadLocationException - if position is not valid in the given document

Eclipse Platform
Release 3.4

Guidelines for using Eclipse APIs.

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