javafx.scene.input

Класс DragEvent

java.lang. Объект

java.util. EventObject

javafx.event. Событие

javafx.scene.input. InputEvent

javafx.scene.input. DragEvent

Все Реализованные Интерфейсы:

java.io. Сериализуемый, java.lang. Cloneable

public class DragEvent
extends InputEvent

Перетащите события от нажатия мыши замены событий во время жеста перетаскивать-и-отбрасывать. Различие между "нажатием перетаскивает выпуск", и жесты перетаскивать-и-отбрасывать описывается в MouseEvent.

Перетащите и отбросьте жест, может быть запущен, вызывая startDragAndDrop () внутри обработчик событий DRAG_DETECTED. Данные, которые будут переданы, чтобы отбросить цель, помещаются в a dragBoard в этот момент.

Перетащите ввел/вышел, события ведут себя так же к мыши, ввел/вышел события, пожалуйста, см. MouseEvent краткий обзор.

Перетащите источники: инициирование жеста перетаскивания и отбрасывания

Когда перетащить жест обнаруживается, приложение может решить, начать ли жест перетаскивания и отбрасывания или продолжать жестом "нажатие, перетаскивают выпуск".

Значение по умолчанию перетаскивает перемещения мыши использования механизма обнаружения с нажатой кнопкой в комбинации с гистерезисом. Это поведение может быть увеличено приложением. Каждый MOUSE_PRESSED и MOUSE_DRAGGED у события есть a dragDetect флаг, который определяет, был ли обнаружен перетащить жест. Значение по умолчанию этого флага зависит от механизма обнаружения значения по умолчанию и может быть изменено, вызывая setDragDetect() в обработчике событий. Когда обработка одного из этих событий заканчивается dragDetect отметьте набор к истине, a DRAG_DETECTED MouseEvent отправляется потенциальному источнику жеста (объект, на котором кнопка мыши была нажата). Это событие уведомляет об обнаружении жеста.

Внутри a DRAG_DETECTED обработчик событий, если startDragAndDrop() метод вызывают на узле или сцене, и перетащенные данные делаются доступными для возвращенного Dragboard, объект тот, на который startDragAndDrop() был вызван considred, источник жеста и жест перетаскивания и отбрасывания запускаются. Dragboard имеет системную функциональность буфера обмена, но определенно используется для, перетаскивают и отбрасывают передачу данных.

startDragAndDrop() метод берет ряд TransferModes поддерживаемый источником жеста. Например передача только TransferMode.COPY указывает, что источник жеста позволяет только копировать данных, не перемещаясь или ссылаясь.

Следующий пример показывает, что простое перетаскивает и отбрасывает источник:

Rectangle rect = new Rectangle(100, 100);
rect.setOnDragDetected(new EventHandler() {
    @Override public void handle(MouseEvent event) {
        Dragboard db = startDragAndDrop(TransferMode.ANY);
        ClipboardContent content = new ClipboardContent();
        content.putString("Hello!");
        db.setContent(content);
        event.consume();
    }
});
 

Потенциальные цели отбрасывания

После того, как жест перетаскивания и отбрасывания был запущен, любой объект (Node, Scene) по которому перетаскивается мышь, потенциальная цель отбрасывания.

Когда мышь перетаскивается в границы потенциальной цели отбрасывания, потенциальная цель получает a DRAG_ENTERED событие. Когда мышь перетаскивается за пределами границ потенциальной цели, это получает a DRAG_EXITED событие. Есть также пузырение DRAG_ENTERED_TARGET и DRAG_EXITED_TARGET разновидности. Они ведут себя так же к мыши, ввел/вышел события, пожалуйста, см. MouseEvent краткий обзор.

Потенциальная цель отбрасывания может решить изменить свое появление, чтобы позволить пользователю знать, что перетащенные данные могут быть отброшены на ней. Это может быть сделано в a DRAG_OVER обработчик событий, основанный на позиции мыши. Другая опция должна изменить появление потенциальной цели в a DRAG_ENTERED и DRAG_EXITED обработчики.

В DRAG_OVER обработчик событий у потенциальной цели отбрасывания есть возможность сделать известным, что это - фактическая цель. Это делается, вызывая acceptTransferModes(TransferMode...) на событии передавая режимы передачи это готово принять. Если это не вызывают во время поставки события или если ни один из переданных режимов передачи не поддерживается источником жеста, то потенциальная цель отбрасывания, как полагают, не является фактической целью отбрасывания.

Решая погоду, чтобы принять событие, вызывая acceptTransferModes(TransferMode...), тип доступных данных на Dragboard должен быть рассмотрен. Доступ к Dragboard обеспечивается getDragboard() метод.

Принимая событие, потенциальная цель жеста решает который TransferMode принимается для работы. Принять решение, DragBoard.getTransferModes() (набор режимов передачи, поддерживаемых источником жеста) и DragEvent.getTransferMode() (режим передачи значения по умолчанию, выпущенный платформой, управляемой ключевыми модификаторами), может использоваться. Это - poosible, чтобы передать больше режимов передачи в acceptTransferModes(TransferMode...) метод. В этом случае это принимает решение в имени приложения (это выбирает режим по умолчанию, если это поддерживается источником жеста и принимается целью жеста, иначе это выбирает наиболее распространенный режим поддерживаемых и принятых). DRAG_DROPPED событие getTransferMode() более поздние отчеты режим передачи, принятый DRAG_OVER обработчик событий.

Жест перетаскивания и отбрасывания заканчивается, когда кнопка мыши отпускается. Если это происходит по цели жеста, которая приняла предыдущий DRAG_OVER события с режимом передачи, поддерживаемым источником жеста, a DRAG_DROPPED событие отправляется цели жеста. В его обработчике цель жеста может получить доступ к данным на dragboard. После того, как данные были переданы (или решены, чтобы не передать), жест должен быть завершен, вызывая setDropCompleted(Boolean) на событии. Boolean параметр указывает, были ли данные переданы успешно или нет. Если это не вызывают, жест считают неудачным.

Следующий пример показывает, что простое перетаскивает и отбрасывает цель для текстовых данных:

Rectangle rect = new Rectangle(100, 100);

rect.setOnDragOver(new EventHandler() {
    @Override public void handle(DragEvent event) {
        Dragboard db = event.getDragboard();
        if (db.hasString()) {
            event.acceptTransferModes(TransferMode.COPY_OR_MOVE);
        }
        event.consume();
    }
});

rect.setOnDragDropped(new EventHandler() {
    @Override public void handle(DragEvent event) {
        Dragboard db = event.getDragboard();
        boolean success = false;
        if (db.hasString()) {
            System.out.println("Dropped: " + db.getString());
            success = true;
        }
        event.setDropCompleted(success);
        event.consume();
    }
});
 

Перетащите источники: завершение перетаскивает и отбрасывает жест

После того, как жест был закончен, ли успешной или неудачной передачей данных или быть отмененным, DRAG_DONE событие отправляется источнику жеста. getTransferMode() метод события указывает к источнику жеста, как передача данных была завершена. Если у режима передачи есть значение MOVE, тогда это позволяет источнику убирать свои данные. Очистка данных источника дает соответствующее появление пользователю, что данные были перемещены жестом перетаскивания и отбрасывания. Если у этого есть значение null, тогда жест перетаскивания и отбрасывания, законченный без любых передаваемых данных. Это могло произойти в результате события выпуска мыши по узлу, который не является целью отбрасывания, или пользователем, нажимающим клавишу ESC, чтобы отменить жест перетаскивания и отбрасывания, или целью жеста создание отчетов о неудачной передаче данных.

См. Также:

Сериализированная Форма

Полевая Сводка

Поля

Модификатор и Тип	Поле и Описание
static EventType<DragEvent>	ЛЮБОЙ Общий супертип для всех перетаскивает типы события.
static EventType<DragEvent>	DRAG_DONE Это событие имеет место на источнике жеста перетаскивать-и-отбрасывать после того, как его данные были отброшены на цели отбрасывания.
static EventType<DragEvent>	DRAG_DROPPED Это событие имеет место, когда кнопка мыши отпускается во время, перетаскивают и отбрасывают жест на цели отбрасывания.
static EventType<DragEvent>	DRAG_ENTERED Это событие имеет место, когда перетаскивают жест, вводит узел.
static EventType<DragEvent>	DRAG_ENTERED_TARGET Это событие имеет место, когда перетаскивают жест, вводит узел.
static EventType<DragEvent>	DRAG_EXITED Это событие имеет место, когда перетаскивают выходы жеста узел.
static EventType<DragEvent>	DRAG_EXITED_TARGET Это событие имеет место, когда перетаскивают жест exitenters узел.
static EventType<DragEvent>	DRAG_OVER Это событие имеет место, когда перетаскивают продвижения жеста в пределах этого узла.

Поля, наследованные от class javafx.event. Событие

consumed, eventType, NULL_SOURCE_TARGET, target

Поля, наследованные от class java.util. EventObject

source

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
void	acceptTransferModes(TransferMode... transferModes) Принимает это DragEvent, выбор режима передачи для работы отбрасывания.
Событие	copyFor(java.lang.Object newSource, EventTarget newTarget) Создает и возвращает копию этого события с указанным источником события и целью.
TransferMode	getAcceptedTransferMode() Получает режим передачи, принятый потенциальной целью.
Dragboard	getDragboard() dragboard, который доступен, чтобы передать данные.
java.lang.Object	getGestureSource() Исходный объект жеста перетаскивания и отбрасывания.
java.lang.Object	getGestureTarget() Целевой объект жеста перетаскивания и отбрасывания.
double	getSceneX() Горизонтальная позиция возвратов события относительно источника Scene это содержит источник DragEvent.
double	getSceneY() Вертикальная позиция возвратов события относительно источника Scene это содержит источник DragEvent.
double	getScreenX() Возвраты абсолютная горизонтальная позиция события.
double	getScreenY() Возвраты абсолютная вертикальная позиция события.
TransferMode	getTransferMode() Режим передачи данных.
double	getX() Горизонтальная позиция события относительно источника источника DragEvent.
double	getY() Вертикальная позиция события относительно источника источника DragEvent.
boolean	isAccepted() Указывает, было ли это событие принято.
boolean	isDropCompleted() Ли setDropCompleted(true) был вызван на этом событии.
void	setDropCompleted(boolean isTransferDone) Указывает что обработка передачи этого DragEvent был завершен успешно во время a DRAG_DROPPED обработчик событий.

Методы, наследованные от class javafx.event. Событие

clone, consume, fireEvent, getEventType, getTarget, isConsumed

Методы, наследованные от class java.util. EventObject

getSource, toString

Методы, наследованные от class java.lang. Объект

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Полевая Деталь

ЛЮБОЙ

public static final EventType<DragEvent> ANY

Общий супертип для всех перетаскивает типы события.

DRAG_ENTERED_TARGET

public static final EventType<DragEvent> DRAG_ENTERED_TARGET

Это событие имеет место, когда перетаскивают жест, вводит узел. Это - пузырящаяся разновидность, которая поставляется также всем родителям вводимого узла (если это не было использовано). Когда уведомления о вводе некоторых из дочерних элементов узла не требуются, DRAG_ENTERED обработчик событий должен использоваться.

См. Также:

for more information about mouse entered/exited handling which is similar

DRAG_ENTERED

public static final EventType<DragEvent> DRAG_ENTERED

Это событие имеет место, когда перетаскивают жест, вводит узел. Этот тип события поставляется только вводимому узлу, если родители хотят фильтровать это или получить пузырящееся событие, они должны использовать DRAG_ENTERED_TARGET.

См. Также:

for more information about mouse entered/exited handling which is similar

DRAG_EXITED_TARGET

public static final EventType<DragEvent> DRAG_EXITED_TARGET

Это событие имеет место, когда перетаскивают жест exitenters узел. Это - пузырящаяся разновидность, которая поставляется также всем родителям eixited узла (если это не было использовано). Когда уведомления о выходе из некоторых из дочерних элементов узла не требуются, DRAG_EXITED обработчик событий должен использоваться.

См. Также:

for more information about mouse entered/exited handling which is similar

DRAG_EXITED

public static final EventType<DragEvent> DRAG_EXITED

Это событие имеет место, когда перетаскивают выходы жеста узел. Этот тип события поставляется только узлу, из которого выходят, если родители хотят фильтровать это или получить пузырящееся событие, они должны использовать DRAG_EXITED_TARGET.

См. Также:

for more information about mouse entered/exited handling which is similar

DRAG_OVER

public static final EventType<DragEvent> DRAG_OVER

Это событие имеет место, когда перетаскивают продвижения жеста в пределах этого узла.

DRAG_DROPPED

public static final EventType<DragEvent> DRAG_DROPPED

Это событие имеет место, когда кнопка мыши отпускается во время, перетаскивают и отбрасывают жест на цели отбрасывания. Передача данных от DragEvent's dragboard должен произойти в обработчике этого события.

DRAG_DONE

public static final EventType<DragEvent> DRAG_DONE

Это событие имеет место на источнике жеста перетаскивать-и-отбрасывать после того, как его данные были отброшены на цели отбрасывания. transferMode из шоу события, что только произошло в цели отбрасывания. Если transferMode имеет значение MOVE, тогда источник может убрать свои данные. Очистка данных источника дает соответствующее появление пользователю, что данные были перемещены жестом перетаскивания и отбрасывания. A transferMode у этого есть значение NONE указывает, что никакие данные не были переданы во время жеста перетаскивания и отбрасывания.

Деталь метода

copyFor

public Event copyFor(java.lang.Object newSource,
            EventTarget newTarget)

Описание скопировало с class: Event

Создает и возвращает копию этого события с указанным источником события и целью. Если источник или цель устанавливаются в null, это заменяется NULL_SOURCE_TARGET значение.

Переопределения:

copyFor в class Event

Параметры:

newSource - новый источник скопированного события

newTarget - новая цель скопированного события

Возвраты:

копия события с новым источником и целью

getX

public final double getX()

Горизонтальная позиция события относительно источника источника DragEvent.

Возвраты:

горизонтальная позиция события относительно источника источника DragEvent.

getY

public final double getY()

Вертикальная позиция события относительно источника источника DragEvent.

Возвраты:

вертикальная позиция события относительно источника источника DragEvent.

getScreenX

public final double getScreenX()

Возвраты абсолютная горизонтальная позиция события.

Возвраты:

абсолютная горизонтальная позиция события

getScreenY

public final double getScreenY()

Возвраты абсолютная вертикальная позиция события.

Возвраты:

абсолютная вертикальная позиция события

getSceneX

public final double getSceneX()

Горизонтальная позиция возвратов события относительно источника Scene это содержит источник DragEvent. Если узел не находится в a Scene, тогда значение относительно boundsInParent корневого больше всего родителя узла DragEvent.

Возвраты:

горизонтальная позиция события относительно источника Scene это содержит источник DragEvent

getSceneY

public final double getSceneY()

Вертикальная позиция возвратов события относительно источника Scene это содержит источник DragEvent. Если узел не находится в a Scene, тогда значение относительно boundsInParent корневого больше всего родителя узла DragEvent.

Возвраты:

вертикальная позиция события относительно источника Scene это содержит источник DragEvent

getGestureSource

public final java.lang.Object getGestureSource()

Исходный объект жеста перетаскивания и отбрасывания. Источник жеста является объектом, который запускался, перетаскивают и отбрасывают работу. Значение null допустимо в случае, что жест прибывает из другого приложения.

getGestureTarget

public final java.lang.Object getGestureTarget()

Целевой объект жеста перетаскивания и отбрасывания. Цель жеста является объектом, который принимает, перетаскивают события. Значение null допустимо в случае, что жест перетаскивания и отбрасывания был отменен или завершен без передачи, имеющей место или нет в настоящий момент никакой цели события принятия перетащить событий.

getTransferMode

public final TransferMode getTransferMode()

Режим передачи данных. Прежде, чем передача данных, выполняется, это - режим передачи значения по умолчанию, установленный системой согласно входным событиям, таким как пользователь, содержащий некоторые модификаторы. Во время передачи данных (в событии DRAG_DROPPED) это определяет режим передачи, принятый предыдущим обработчиком DRAG_OVER. После передачи данных (в событии DRAG_DONE) это определяет фактический режим сделанной передачи.

isAccepted

public final boolean isAccepted()

Указывает, было ли это событие принято.

См. Также:

acceptTransferModes(javafx.scene.input.TransferMode...)

getAcceptedTransferMode

public final TransferMode getAcceptedTransferMode()

Получает режим передачи, принятый потенциальной целью.

Возвраты:

режим передачи принимается потенциальной целью.

getDragboard

public final Dragboard getDragboard()

dragboard, который доступен, чтобы передать данные. Данные могут быть помещены на этот dragboard в обработчике DRAG_DETECTED событие от нажатия мыши. Данные могут быть скопированы с этого dragboard в обработчике DRAG_DROPPED событие.

acceptTransferModes

public void acceptTransferModes(TransferMode... transferModes)

Принимает это DragEvent, выбор режима передачи для работы отбрасывания. Используемый, чтобы указать, что потенциальная цель отбрасывания, которая получает это событие, является целью отбрасывания от DRAG_OVER обработчик событий.

Это принимает один из режимов передачи, которые и передают в этот метод и поддерживаются источником жеста. Это принимает режим передачи значения по умолчанию если возможный, иначе наиболее распространенный из приемлемых режимов.

setDropCompleted

public void setDropCompleted(boolean isTransferDone)

Указывает что обработка передачи этого DragEvent был завершен успешно во время a DRAG_DROPPED обработчик событий. Нет dragboard доступ может произойти после этого вызова.

Параметры:

isTransferDone - true указывает, что передача была успешна.

Броски:

java.lang.IllegalStateException - если это не событие DRAG_DROPPED

isDropCompleted

public boolean isDropCompleted()

Ли setDropCompleted(true) был вызван на этом событии.

Возвраты:

истина, если setDropCompleted(true) был вызван