Класс TransferHandler.TransferSupport

java.lang.Object

javax.swing.TransferHandler.TransferSupport

Внешний класс:: TransferHandler

public static final class TransferHandler.TransferSupport extends Object

Этот класс содержит все необходимые сведения о передаче данных через буфер обмена или перетаскиванием, а также позволяет настраивать параметры перетаскивания.

Основная цель этого класса — предоставить разработчику информацию, необходимую для определения пригодности передачи или импорта содержащихся в ней данных. Кроме того, класс служит контроллером для настройки свойств во время перетаскивания, например для управления отображением места сброса и выбора действия при сбросе.

Как правило, разработчикам не нужно создавать экземпляры этого класса. Вместо этого реализация DnD передает их определенным методам в TransferHandler.

С момента выпуска:

1.6

См. также:

Краткое описание конструкторов

Конструктор	Описание
`TransferSupport(Component component, Transferable transferable)`	Создает `TransferSupport` с `isDrop()` `false` для указанного компонента и `Transferable`.

Краткое описание методов

Модификатор и тип	Метод	Описание
`Component`	`getComponent()`	Возвращает целевой компонент этой передачи.
`DataFlavor[]`	`getDataFlavors()`	Возвращает форматы данных для этой передачи.
`int`	`getDropAction()`	Возвращает выбранное действие при сбросе, если этот `TransferSupport` представляет собой сброс.
`TransferHandler.DropLocation`	`getDropLocation()`	Возвращает текущее место сброса (не-`null`) для компонента, если этот `TransferSupport` представляет собой сброс.
`int`	`getSourceDropActions()`	Возвращает поддерживаемые источником перетаскивания действия при сбросе, если этот `TransferSupport` представляет собой сброс.
`Transferable`	`getTransferable()`	Возвращает `Transferable`, связанный с этой передачей.
`int`	`getUserDropAction()`	Возвращает выбранное пользователем действие при сбросе, если этот `TransferSupport` представляет собой сброс.
`boolean`	`isDataFlavorSupported(DataFlavor df)`	Возвращает, поддерживается ли указанный формат данных.
`boolean`	`isDrop()`	Возвращает, представляет ли этот `TransferSupport` операцию сброса.
`void`	`setDropAction(int dropAction)`	Задает для передачи действие при сбросе — которая должна представлять собой сброс — указанное действие вместо действия по умолчанию, выбранного пользователем.
`void`	`setShowDropLocation(boolean showDropLocation)`	Задает, следует ли визуально обозначать место сброса для передачи, которая должна представлять собой сброс.

Методы, объявленные в классе Object

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект какому-либо другому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API может быть удален в будущей версии. Финализация объявлена устаревшей и будет удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

Подробное описание конструкторов

TransferSupport

public TransferSupport(Component component, Transferable transferable)

Создает TransferSupport с isDrop() false для указанного компонента и Transferable.

Параметры:: component — целевой компонент; transferable — передаваемый объект
Исключения:: NullPointerException — если один из параметров равен null

Подробное описание методов

isDrop

public boolean isDrop()

Возвращает, представляет ли этот TransferSupport операцию сброса.

Возвращает:: true, если это операция сброса, и false в противном случае.

getComponent

public Component getComponent()

Возвращает целевой компонент этой передачи.

Возвращает:: целевой компонент

getDropLocation

public TransferHandler.DropLocation getDropLocation()

Возвращает текущее место сброса (не-null) для компонента, если этот TransferSupport представляет собой сброс.

Примечание. Для компонентов со встроенной поддержкой сброса это место будет подклассом DropLocation того же типа, который возвращает метод getDropLocation этого компонента.

Этот метод предназначен только для передач посредством перетаскивания. Его вызов, если isDrop() равен false, приводит к IllegalStateException.

Возвращает:

место сброса

Исключения:

IllegalStateException — если это не сброс

См. также:

setShowDropLocation

public void setShowDropLocation(boolean showDropLocation)

Задает, следует ли визуально обозначать место сброса для передачи, которая должна представлять собой сброс. Это применимо к компонентам, автоматически отображающим место сброса в нужный момент во время операции перетаскивания. По умолчанию место сброса отображается только в том случае, если TransferHandler подтвердил возможность импорта, представленного этим TransferSupport. Этот метод позволяет принудительно включить или отключить отображение места сброса.

Параметры:

showDropLocation — следует ли обозначать место сброса

Исключения:

IllegalStateException — если это не сброс

См. также:

setDropAction

public void setDropAction(int dropAction)

Задает для передачи действие при сбросе — которая должна представлять собой сброс — указанное действие вместо действия по умолчанию, выбранного пользователем. Это действие должно поддерживаться действиями при сбросе источника и должно быть одним из следующих: COPY, MOVE или LINK.

Параметры:

dropAction — действие при сбросе

Исключения:

IllegalStateException — если это не сброс

IllegalArgumentException — если указано недопустимое действие

См. также:

getDropAction

public int getDropAction()

Возвращает выбранное действие при сбросе, если этот TransferSupport представляет собой сброс.

Если действие не было явно выбрано с помощью setDropAction, этот метод возвращает действие при сбросе, выбранное пользователем и предоставленное getUserDropAction.

Этот метод можно использовать в методе importData класса TransferHandler, чтобы настраивать обработку в зависимости от действия.

Возвращает:

выбранное действие при сбросе

Исключения:

IllegalStateException — если это не сброс

См. также:

getUserDropAction

public int getUserDropAction()

Возвращает выбранное пользователем действие при сбросе, если этот TransferSupport представляет собой сброс.

Действие при сбросе, выбранное пользователем, определяется так, как описано в документации к классам DropTargetDragEvent и DropTargetDropEvent. С помощью метода setDropAction можно выбрать другое действие при сбросе.

Этот метод можно использовать в методе canImport класса TransferHandler при определении пригодности сброса или выборе действия, которое следует явно задать.

Возвращает:

действие при сбросе, выбранное пользователем

Исключения:

IllegalStateException — если это не сброс

См. также:

getSourceDropActions

public int getSourceDropActions()

Возвращает поддерживаемые источником перетаскивания действия при сбросе, если этот TransferSupport представляет собой сброс.

Действия источника представляют набор действий, поддерживаемых источником этой передачи, и задаются побитовой комбинацией COPY, MOVE и LINK. Этот метод можно использовать в методе canImport класса TransferHandler при определении пригодности сброса или выборе действия, которое следует явно задать. Чтобы определить, поддерживается ли источником конкретное действие, выполните побитовое И между этим действием и действиями сброса источника, а затем сравните результат с исходным действием. Например:

boolean copySupported = (COPY & getSourceDropActions()) == COPY;

Возвращает:

поддерживаемые источником перетаскивания действия при сбросе

Исключения:

IllegalStateException — если это не сброс

См. также:

getDataFlavors

public DataFlavor[] getDataFlavors()

Возвращает форматы данных для этой передачи.

Возвращает:: форматы данных для этой передачи

isDataFlavorSupported

public boolean isDataFlavorSupported(DataFlavor df)

Возвращает, поддерживается ли указанный формат данных.

Параметры:: df — формат DataFlavor для проверки
Возвращает:: поддерживается ли указанный формат.

getTransferable

public Transferable getTransferable()

Возвращает Transferable, связанный с этой передачей.

Примечание. Если нет необходимости получать Transferable напрямую, используйте один из других методов этого класса для получения сведений о передаче. Это может работать эффективнее, чем получение Transferable и прямое обращение к нему.

Возвращает:: Transferable, связанный с этой передачей

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.