Spec-Zone.ru › OpenJDK 8

Класс 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, 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.

Spec-Zone.ru

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