net.java.sip.communicator.impl.gui.main.contactlist
Class ContactListTransferHandler

java.lang.Object
  javax.swing.TransferHandler
      net.java.sip.communicator.util.swing.ExtendedTransferHandler
          net.java.sip.communicator.impl.gui.main.contactlist.ContactListTransferHandler

All Implemented Interfaces:

Serializable

public class ContactListTransferHandler
extends ExtendedTransferHandler

A TransferHandler that we use to handle DnD operations in our ContactList.

Author:

Yana Stamcheva

See Also:

Serialized Form

Nested Class Summary

class

ContactListTransferHandler.ContactListTransferable Transferable for JList that enables drag and drop of contacts.

Nested classes/interfaces inherited from class net.java.sip.communicator.util.swing.ExtendedTransferHandler

ExtendedTransferHandler.SelectedTextTransferable

Nested classes/interfaces inherited from class javax.swing.TransferHandler

TransferHandler.DropLocation, TransferHandler.TransferSupport

Field Summary

protected static DataFlavor

uiContactDataFlavor The data flavor used when transferring UIContacts.

Fields inherited from class javax.swing.TransferHandler

COPY, COPY_OR_MOVE, LINK, MOVE, NONE

Constructor Summary

ContactListTransferHandler(DefaultTreeContactList contactList)
Creates an instance of ContactListTransferHandler passing the contactList which uses this TransferHandler.

Method Summary

boolean	canImport(JComponent comp, DataFlavor[] flavor) Indicates whether a component will accept an import of the given set of data flavors prior to actually attempting to import it.
Transferable	createTransferable(JComponent component) Creates a transferable for text pane components in order to enable drag and drop of text.
Icon	getVisualRepresentation(Transferable t) Overrides TransferHandler.getVisualRepresentation(Transferable t) in order to return a custom drag icon.
boolean	importData(JComponent comp, Transferable t) Handles transfers to the contact list from the clip board or a DND drop operation.

Methods inherited from class net.java.sip.communicator.util.swing.ExtendedTransferHandler

exportAsDrag, exportToClipboard, getSourceActions

Methods inherited from class javax.swing.TransferHandler

canImport, exportDone, getCopyAction, getCutAction, getPasteAction, importData

Methods inherited from class java.lang.Object

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

Field Detail

uiContactDataFlavor

protected static final DataFlavor uiContactDataFlavor

The data flavor used when transferring UIContacts.

Constructor Detail

ContactListTransferHandler

public ContactListTransferHandler(DefaultTreeContactList contactList)

Creates an instance of ContactListTransferHandler passing the contactList which uses this TransferHandler.

Parameters:

contactList - the DefaultContactList which uses this TransferHandler

Method Detail

createTransferable

public Transferable createTransferable(JComponent component)

Creates a transferable for text pane components in order to enable drag and drop of text.

Overrides:

createTransferable in class ExtendedTransferHandler

Parameters:

component - the component for which to create a Transferable

Returns:

the created Transferable

canImport

public boolean canImport(JComponent comp,
                         DataFlavor[] flavor)

Indicates whether a component will accept an import of the given set of data flavors prior to actually attempting to import it. We return true to indicate that the transfer with at least one of the given flavors would work and false to reject the transfer.

Overrides:

canImport in class ExtendedTransferHandler

Parameters:

comp - component

flavor - the data formats available

Returns:

true if the data can be inserted into the component, false otherwise

Throws:

NullPointerException - if support is null

importData

public boolean importData(JComponent comp,
                          Transferable t)

Handles transfers to the contact list from the clip board or a DND drop operation. The Transferable parameter contains the data that needs to be imported.

Overrides:

importData in class TransferHandler

Parameters:

comp - the component to receive the transfer

t - the data to import

Returns:

true if the data was inserted into the component; false, otherwise

See Also:

TransferHandler.importData(JComponent, Transferable)

getVisualRepresentation

public Icon getVisualRepresentation(Transferable t)

Overrides TransferHandler.getVisualRepresentation(Transferable t) in order to return a custom drag icon.

The default parent implementation of this method returns null.

Overrides:

getVisualRepresentation in class ExtendedTransferHandler

Parameters:

t - the data to be transferred; this value is expected to have been created by the createTransferable method

Returns:

the icon to show when dragging