Класс TransferHandler.TransferSupport
- Вложенный класс:
- TransferHandler
public static final class TransferHandler.TransferSupport extends Object
Основная цель этого класса — предоставить разработчику информацию, необходимую для определения пригодности передачи или импорта содержащихся данных. Но он также используется как контроллер для настройки свойств во время перетаскивания, например, отображения или не отображения места назначения и выбора действия при падении.
Разработчикам обычно не нужно создавать экземпляры этого класса. Вместо этого они предоставляются реализацией DnD для определенных методов в TransferHandler.
Краткое описание конструкторов
| Конструктор | Описание |
|---|---|
TransferSupport |
Создает 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 |
Возвращает, поддерживается ли данный тип данных. |
boolean |
isDrop() |
Возвращает, представляет ли эта TransferSupport операцию падения. |
void |
setDropAction |
Устанавливает действие при падении для передачи — которое должно представлять падение — на заданное действие вместо стандартного действия падения пользователя. |
void |
setShowDropLocation |
Устанавливает, должно ли местоположение падения визуально обозначаться для передачи — которая должна представлять падение. |
Подробное описание конструкторов
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. С помощью этого метода можно принудительно отображать или не отображать местоположение переноса. Этот метод предназначен только для использования с операциями переноса перетаскивания. Вызов его, когда isDrop() является false, приводит к IllegalStateException.
- Параметры:
-
showDropLocation- отображать ли местоположение переноса - Исключения:
-
IllegalStateException- если это не перенос - См. также:
setDropAction
public void setDropAction(int dropAction)
COPY, MOVE или LINK. Этот метод предназначен только для использования с операциями переноса перетаскивания. Вызов его, когда isDrop() является false, приводит к IllegalStateException.
- Параметры:
-
dropAction- действие переноса - Исключения:
-
IllegalStateException- если это не перенос -
IllegalArgumentException- если указано неверное действие - См. также:
getDropAction
public int getDropAction()
TransferSupport представляет собой перенос. Если это не было явно выбрано с помощью setDropAction, возвращается действие переноса пользователя, предоставленное getUserDropAction.
Возможно, вам захочется запросить это в методе TransferHandler importData, чтобы настроить обработку в зависимости от действия.
Этот метод предназначен только для использования с операциями переноса перетаскивания. Вызов его, когда isDrop() является false, приводит к IllegalStateException.
- Возвращает:
- выбранное действие переноса
- Исключения:
-
IllegalStateException- если это не перенос - См. также:
getUserDropAction
public int getUserDropAction()
TransferSupport представляет собой перенос. Действие переноса пользователя выбирается для переноса, как описано в документации для DropTargetDragEvent и DropTargetDropEvent. Другое действие может быть выбрано в качестве действия переноса с помощью метода setDropAction.
Возможно, вам захочется запросить это в методе TransferHandler canImport, чтобы определить пригодность переноса или принять решение о действии переноса, которое следует явно выбрать.
Этот метод предназначен только для использования с операциями переноса перетаскивания. Вызов его, когда isDrop() является false, приводит к IllegalStateException.
- Возвращает:
- действие переноса пользователя
- Исключения:
-
IllegalStateException- если это не перенос - См. также:
getSourceDropActions
public int getSourceDropActions()
TransferSupport представляет собой перенос. Действия источника представляют собой набор действий, поддерживаемых источником этого переноса, и представлены как некоторое побитовое ИЛИ сочетание COPY, MOVE и LINK. Возможно, вам захочется запросить это в методе TransferHandler canImport, чтобы определить пригодность переноса или принять решение о действии переноса, которое следует явно выбрать. Чтобы определить, поддерживается ли конкретное действие источником, побитово И (AND) действие со средствами переноса источника и затем сравните результат с исходным действием. Например:
boolean copySupported = (COPY & getSourceDropActions()) == COPY;
Этот метод предназначен только для использования с операциями переноса перетаскивания. Вызов его, когда isDrop() является false, приводит к IllegalStateException.
- Возвращает:
- поддерживаемые действия переноса источника перетаскивания
- Исключения:
-
IllegalStateException- если это не перенос - См. также:
getDataFlavors
public DataFlavor[] getDataFlavors()
- Возвращает:
- типы данных для этого переноса
isDataFlavorSupported
public boolean isDataFlavorSupported(DataFlavor df)
- Параметры:
-
df- тип данных для проверки - Возвращает:
- поддерживается ли данный тип данных.
getTransferable
public Transferable getTransferable()
Transferable, связанный с этим переносом. Примечание: если нет необходимости получить Transferable непосредственно, используйте один из других методов в этом классе для запроса переноса. Это может быть выполнено быстрее, чем получение Transferable и непосредственный запрос у него.
- Возвращает:
Transferableсвязанный с этим переносом
© 1993, 2021, 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/17/docs/api/java.desktop/javax/swing/TransferHandler.TransferSupport.html