Класс 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 - DataFlavor для проверки
Возвращает:
поддерживается ли данный тип данных.

getTransferable

public Transferable getTransferable()

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

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

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

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

Spec-Zone .ru
спецификации, руководства, описания, API