Spec-Zone.ru › OpenJDK 21

Класс 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's importData для настройки обработки, основанной на действии.

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

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

getUserDropAction

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

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

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

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

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

getSourceDropActions

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

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

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

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

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

getDataFlavors

public DataFlavor[] getDataFlavors()
Возвращает типы данных для этого переноса.
Возвращает:
типы данных для этого переноса

isDataFlavorSupported

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

getTransferable

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

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

Возвращает:
связанный с этим переносом Transferable

© 1993, 2023, 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/21/docs/api/java.desktop/javax/swing/TransferHandler.TransferSupport.html

Spec-Zone.ru

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