akasha

Class DataTransfer

java.lang.Object

akasha.core.JsObject

akasha.DataTransfer

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="DataTransfer")
public class DataTransfer
extends JsObject

The DataTransfer object is used to hold the data that is being dragged during a drag and drop operation. It may hold one or more data items, each of one or more data types. For more information about drag and drop, see HTML Drag and Drop API.

See Also:

DataTransfer - MDN, # the-datatransfer-interface

Field Summary

Fields

Modifier and Type	Field and Description
@JsNonNull java.lang.String	dropEffect The DataTransfer.dropEffect property controls the feedback (typically visual) the user is given during a drag and drop operation.
@JsNonNull java.lang.String	effectAllowed The DataTransfer.effectAllowed property specifies the effect that is allowed for a drag operation.

Constructor Summary

Constructors

Constructor and Description
DataTransfer() The DataTransfer constructor creates a new DataTransfer object instance.

Method Summary

Modifier and Type	Method and Description
void	clearData() The DataTransfer.clearData() method removes the drag operation's drag data for the given type.
void	clearData(java.lang.String format) The DataTransfer.clearData() method removes the drag operation's drag data for the given type.
FileList	files() The DataTransfer.files property is a list of the files in the drag operation.
@JsNonNull java.lang.String	getData(java.lang.String format) The DataTransfer.getData() method retrieves drag data (as a DOMString) for the specified type.
DataTransferItemList	items() The read-only DataTransfer property items property is a list of the data transfer items in a drag operation.
void	setData(java.lang.String format, java.lang.String data) The DataTransfer.setData() method sets the drag operation's drag data to the specified data and type.
void	setDragImage(Element image, int x, int y) When a drag occurs, a translucent image is generated from the drag target (the element the dragstart event is fired at), and follows the mouse pointer during the drag.
JsArray<java.lang.String>	types() The DataTransfer.types read-only property returns an array of the drag data formats (as strings) that were set in the dragstart event.

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

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

Field Detail

dropEffect

public @JsNonNull java.lang.String dropEffect

The DataTransfer.dropEffect property controls the feedback (typically visual) the user is given during a drag and drop operation. It will affect which cursor is displayed while dragging. For example, when the user hovers over a target drop element, the browser's cursor may indicate which type of operation will occur.

See Also:

DataTransfer.dropEffect - MDN, dropEffect - HTML Living Standard, dropEffect - HTML 5.1

effectAllowed

public @JsNonNull java.lang.String effectAllowed

The DataTransfer.effectAllowed property specifies the effect that is allowed for a drag operation. The copy operation is used to indicate that the data being dragged will be copied from its present location to the drop location. The move operation is used to indicate that the data being dragged will be moved, and the link operation is used to indicate that some form of relationship or connection will be created between the source and drop locations.

See Also:

DataTransfer.effectAllowed - MDN, effectAllowed - HTML Living Standard, effectAllowed - HTML 5.1

Constructor Detail

DataTransfer

public DataTransfer()

The DataTransfer constructor creates a new DataTransfer object instance.

See Also:

DataTransfer.DataTransfer - MDN, the DataTransfer() constructor - HTML Living Standard

Method Detail

files

@JsProperty(name="files")
 @Nonnull
public FileList files()

The DataTransfer.files property is a list of the files in the drag operation. If the operation includes no files, the list is empty.

See Also:

DataTransfer.files - MDN, files - HTML Living Standard, files - HTML 5.1

items

@JsProperty(name="items")
 @Nonnull
public DataTransferItemList items()

The read-only DataTransfer property items property is a list of the data transfer items in a drag operation. The list includes one item for each item in the operation and if the operation had no items, the list is empty.

See Also:

DataTransfer.items - MDN, items - HTML Living Standard, items - HTML 5.1

types

@JsProperty(name="types")
 @Nonnull
public JsArray<java.lang.String> types()

The DataTransfer.types read-only property returns an array of the drag data formats (as strings) that were set in the dragstart event. The order of the formats is the same order as the data included in the drag operation.

See Also:

DataTransfer.types - MDN, types - HTML Living Standard, types - HTML 5.1

clearData

public void clearData(@Nonnull
                      java.lang.String format)

The DataTransfer.clearData() method removes the drag operation's drag data for the given type. If data for the given type does not exist, this method does nothing.

See Also:

DataTransfer.clearData - MDN, DataTransfer.clearData() - HTML Living Standard, DataTransfer.clearData() - HTML 5.1

clearData

public void clearData()

The DataTransfer.clearData() method removes the drag operation's drag data for the given type. If data for the given type does not exist, this method does nothing.

See Also:

DataTransfer.clearData - MDN, DataTransfer.clearData() - HTML Living Standard, DataTransfer.clearData() - HTML 5.1

getData

public @JsNonNull java.lang.String getData(@Nonnull
                                           java.lang.String format)

The DataTransfer.getData() method retrieves drag data (as a DOMString) for the specified type. If the drag operation does not include data, this method returns an empty string.

See Also:

DataTransfer.getData - MDN, getData() - HTML Living Standard, getData() - HTML 5.1

setData

public void setData(@Nonnull
                    java.lang.String format,
                    @Nonnull
                    java.lang.String data)

The DataTransfer.setData() method sets the drag operation's drag data to the specified data and type. If data for the given type does not exist, it is added at the end of the drag data store, such that the last item in the types list will be the new type. If data for the given type already exists, the existing data is replaced in the same position. That is, the order of the types list is not changed when replacing data of the same type.

See Also:

DataTransfer.setData - MDN, setData() - HTML Living Standard, setData() - HTML 5.1

setDragImage

public void setDragImage(@Nonnull
                         Element image,
                         int x,
                         int y)

When a drag occurs, a translucent image is generated from the drag target (the element the dragstart event is fired at), and follows the mouse pointer during the drag. This image is created automatically, so you do not need to create it yourself. However, if a custom image is desired, the DataTransfer.setDragImage() method can be used to set the custom image to be used. The image will typically be an image element but it can also be a canvas or any other visible element.

See Also:

DataTransfer.setDragImage - MDN, setDragImage() - HTML Living Standard, setDragImage() - HTML 5.1