Package com.intellij.openapi.ide

Class KillRingTransferable

java.lang.Object

com.intellij.openapi.ide.KillRingTransferable

All Implemented Interfaces:

java.awt.datatransfer.Transferable

public class KillRingTransferable
extends java.lang.Object
implements java.awt.datatransfer.Transferable

This class represents usual transferable string with additional meta-information that describes the place of the document that from there it was retrieved.

The main idea is that we want to be able to combine adjacent text into single unit like emacs kill ring does. E.g. if the user invokes 'cut to the line end' subsequently we may want to paste all of them, hence, we need to be able to distinguish if particular copy-paste strings are adjacent.

Thread-safe.

Constructor Summary

Constructors

Constructor and Description
KillRingTransferable(java.lang.String data, Document document, int startOffset, int endOffset, boolean cut) Creates new KillRingTransferable object.

Method Summary

Modifier and Type	Method and Description
Document	getDocument()
int	getEndOffset()
int	getStartOffset()
java.lang.Object	getTransferData(java.awt.datatransfer.DataFlavor flavor)
java.awt.datatransfer.DataFlavor[]	getTransferDataFlavors()
boolean	isCut()
boolean	isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor)
boolean	isReadyToCombine()
void	setReadyToCombine(boolean readyToCombine) Allows to define if current object can be combined with adjacent text.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

KillRingTransferable

public KillRingTransferable(java.lang.String data,
                            Document document,
                            int startOffset,
                            int endOffset,
                            boolean cut)

Creates new KillRingTransferable object.

Parameters:

data - target text to transfer

document - document that contained given text

startOffset - start offset of the given text at the given document

endOffset - end offset of the given text during current object construction

cut - flag that identifies whether target text was cut or copied from the document

Method Detail

getTransferDataFlavors

public java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()

Specified by:

getTransferDataFlavors in interface java.awt.datatransfer.Transferable

isDataFlavorSupported

public boolean isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor)

Specified by:

isDataFlavorSupported in interface java.awt.datatransfer.Transferable

getTransferData

public java.lang.Object getTransferData(java.awt.datatransfer.DataFlavor flavor)
                                 throws java.awt.datatransfer.UnsupportedFlavorException,
                                        java.io.IOException

Specified by:

getTransferData in interface java.awt.datatransfer.Transferable

Throws:

java.awt.datatransfer.UnsupportedFlavorException

java.io.IOException

getDocument

public Document getDocument()

getStartOffset

public int getStartOffset()

getEndOffset

public int getEndOffset()

Returns:

offset of the target text end on the moment of the current object construction

isCut

public boolean isCut()

isReadyToCombine

public boolean isReadyToCombine()

Returns:

true if current object can be combined with adjacent text; false otherwise. Default value is true

setReadyToCombine

public void setReadyToCombine(boolean readyToCombine)

Allows to define if current object can be combined with adjacent text.

Parameters:

readyToCombine - true if current object can be combined with adjacent text; false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object