Spec-Zone.ru › OpenJDK 24

Класс 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)
Устанавливает, должно ли расположение опускания визуально отображаться для передачи — которая должна представлять опускание.

Методы, унаследованные от класса java.lang.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.

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

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

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

getUserDropAction

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

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

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

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

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

getSourceDropActions

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

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

 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

© 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/swing/TransferHandler.TransferSupport.html

Spec-Zone.ru

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