Spec-Zone.ru › OpenJDK 25

Класс TransferHandler.TransferSupport

java.lang.Object
javax.swing.TransferHandler.TransferSupport
Вмещающий класс:
TransferHandler
public static final class TransferHandler.TransferSupport extends Object
Этот класс инкапсулирует все сведения, относящиеся к передаче данных через буфер обмена или посредством перетаскивания, а также позволяет настраивать аспекты взаимодействия при перетаскивании.

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

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

Начиная с:
1.6
См. также:
  • TransferHandler.canImport(TransferHandler.TransferSupport)
  • TransferHandler.importData(TransferHandler.TransferSupport)

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

Конструктор Описание
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

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

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 — если это не операция сброса
См. также:
  • isDrop()

setShowDropLocation

public void setShowDropLocation(boolean showDropLocation)
Устанавливает, следует ли визуально обозначать место сброса для передачи, которая должна представлять собой операцию сброса. Это применимо к компонентам, которые автоматически отображают место сброса при необходимости во время перетаскивания. По умолчанию место сброса отображается, только если TransferHandler сообщил, что может принять импорт, представленный этим TransferSupport. С помощью этого метода можно принудительно всегда отображать или никогда не отображать место сброса.

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

Параметры:
showDropLocation — следует ли обозначать место сброса
Вызывает исключение:
IllegalStateException — если это не операция сброса
См. также:
  • isDrop()

setDropAction

public void setDropAction(int dropAction)
Устанавливает для передачи действие сброса — которая должна представлять собой операцию сброса, — указанное действие вместо действия сброса, выбранного пользователем по умолчанию. Это действие должно поддерживаться действиями сброса источника и быть одним из следующих: COPY, MOVE или LINK.

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

Параметры:
dropAction — действие сброса
Вызывает исключение:
IllegalStateException — если это не операция сброса
IllegalArgumentException — если указано недопустимое действие
См. также:
  • getDropAction()
  • getUserDropAction()
  • getSourceDropActions()
  • isDrop()

getDropAction

public int getDropAction()
Возвращает действие, выбранное для сброса, если этот TransferSupport представляет собой операцию сброса.

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

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

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

Возвращает:
действие, выбранное для сброса
Вызывает исключение:
IllegalStateException — если это не операция сброса
См. также:
  • setDropAction(int)
  • getUserDropAction()
  • isDrop()

getUserDropAction

public int getUserDropAction()
Возвращает пользовательское действие сброса, если этот TransferSupport представляет собой операцию сброса.

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

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

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

Возвращает:
действие сброса, выбранное пользователем
Вызывает исключение:
IllegalStateException — если это не операция сброса
См. также:
  • setDropAction(int)
  • getDropAction()
  • isDrop()

getSourceDropActions

public int getSourceDropActions()
Возвращает действия сброса, поддерживаемые источником перетаскивания, если этот TransferSupport представляет собой операцию сброса.

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

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

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

Возвращает:
действия сброса, поддерживаемые источником перетаскивания
Вызывает исключение:
IllegalStateException — если это не операция сброса
См. также:
  • isDrop()

getDataFlavors

public DataFlavor[] getDataFlavors()
Возвращает форматы данных этой передачи.
Возвращает:
форматы данных этой передачи

isDataFlavorSupported

public boolean isDataFlavorSupported(DataFlavor df)
Возвращает значение, указывающее, поддерживается ли указанный формат данных.
Параметры:
df — DataFlavor для проверки
Возвращает:
значение, указывающее, поддерживается ли указанный формат данных.

getTransferable

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

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

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

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и рабочие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/javax/swing/TransferHandler.TransferSupport.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API