QuantumClipboard

java.lang.Object
- com.sun.javafx.tk.quantum.QuantumClipboard

All Implemented Interfaces:

TKClipboard
```
final class QuantumClipboard
extends java.lang.Object
implements TKClipboard
```
The implementation of TKClipboard, which is used both for clipboards and dragboards.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.security.AccessControlContext`	`accessContext` Security access context for image loading com.sun.javafx.tk.quantum.QuantumClipboard javafx.scene.input.Clipboard ...
`private static ClipboardAssistance`	`currentDragboard`
`private java.util.List<Pair<DataFormat,java.lang.Object>>`	`dataCache` Cache of the data used for dragboard between setting them and flushing them to system dragboard.
`private Image`	`dragImage` An image which is displayed during the drag operation.
`private double`	`dragOffsetX` An offset of the image which is displayed during the drag operation.
`private double`	`dragOffsetY`
`private static java.util.regex.Pattern`	`findTagIMG`
`private boolean`	`isCaching` Distinguishes between clipboard and dragboard.
`private ClipboardAssistance`	`systemAssistant` Handle to the Glass peer.
`private java.util.Set<TransferMode>`	`transferModesCache` Cache of the transfer modes used for dragboard between setting them and flushing them to system dragboard.

Constructor Summary

Constructors
Modifier Constructor and Description

private QuantumClipboard()
Disallow direct creation of QuantumClipboard

Constructors
Modifier	Constructor and Description
`private`	`QuantumClipboard()` Disallow direct creation of QuantumClipboard

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`clearCache()`
`private void`	`clearDragView()`
`static java.util.Set<TransferMode>`	`clipboardActionsToTransferModes(int actions)`
`void`	`close()`
`private static Image`	`convertObjectToImage(java.lang.Object obj)`
`void`	`flush()`
`private java.security.AccessControlContext`	`getAccessControlContext()`
`static QuantumClipboard`	`getClipboardInstance(ClipboardAssistance assistant)` Gets an instance of QuantumClipboard for the given assistant.
`java.lang.Object`	`getContent(DataFormat dataFormat)` Returns the content stored in this clipboard of the given type, or null if there is no content with this type.
`java.util.Set<DataFormat>`	`getContentTypes()` Gets the set of DataFormat types on this Clipboard instance which have associated data registered on the clipboard.
`(package private) static ClipboardAssistance`	`getCurrentDragboard()`
`static QuantumClipboard`	`getDragboardInstance(ClipboardAssistance assistant, boolean isDragSource)` Gets an instance of QuantumClipboard for the given assistant for usage as dragboard during drag and drop.
`Image`	`getDragView()` Gets the image used as a drag view.
`double`	`getDragViewOffsetX()` Gets the x position of the cursor of the drag view image.
`double`	`getDragViewOffsetY()` Gets the y position of the cursor of the drag view image.
`java.util.Set<TransferMode>`	`getTransferModes()`
`boolean`	`hasContent(DataFormat dataFormat)` Tests whether there is any content on this clipboard of the given DataFormat type.
`private java.lang.String`	`parseIMG(java.lang.Object data)`
`private boolean`	`placeImage(Image image)`
`private static java.nio.ByteBuffer`	`prepareImage(Image image)`
`private static java.nio.ByteBuffer`	`prepareOffset(double offsetX, double offsetY)`
`boolean`	`putContent(Pair<DataFormat,java.lang.Object>... content)` Puts the specified content onto the clipboard.
`private boolean`	`putContentToPeer(Pair<DataFormat,java.lang.Object>... content)`
`private Image`	`readImage()`
`(package private) static void`	`releaseCurrentDragboard()`
`void`	`setDragView(Image image)` Sets the visual representation of data being transfered in a drag and drop gesture.
`void`	`setDragViewOffsetX(double offsetX)` Sets the x position of the cursor of the drag view image.
`void`	`setDragViewOffsetY(double offsetY)` Sets the y position of the cursor of the drag view image.
`void`	`setSecurityContext(java.security.AccessControlContext acc)` This method is used to set security context of the Stage.
`void`	`setSupportedTransferMode(java.util.Set<TransferMode> tm)`
`static int`	`transferModesToClipboardActions(java.util.Set<TransferMode> tms)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - systemAssistant
```
private ClipboardAssistance systemAssistant
```
    Handle to the Glass peer.
  - accessContext
```
private java.security.AccessControlContext accessContext
```
    Security access context for image loading com.sun.javafx.tk.quantum.QuantumClipboard javafx.scene.input.Clipboard ... user code ...
  - isCaching
```
private boolean isCaching
```
    Distinguishes between clipboard and dragboard. This is needed because dragboard's flush() starts DnD operation so it mustn't be called too early.
  - dataCache
```
private java.util.List<Pair<DataFormat,java.lang.Object>> dataCache
```
    Cache of the data used for dragboard between setting them and flushing them to system dragboard.
  - transferModesCache
```
private java.util.Set<TransferMode> transferModesCache
```
    Cache of the transfer modes used for dragboard between setting them and flushing them to system dragboard.
  - dragImage
```
private Image dragImage
```
    An image which is displayed during the drag operation. Set by the user.
  - dragOffsetX
```
private double dragOffsetX
```
    An offset of the image which is displayed during the drag operation. Set by the user.
  - dragOffsetY
```
private double dragOffsetY
```
  - currentDragboard
```
private static ClipboardAssistance currentDragboard
```
  - findTagIMG
```
private static final java.util.regex.Pattern findTagIMG
```
- Constructor Detail
  - QuantumClipboard
```
private QuantumClipboard()
```
    Disallow direct creation of QuantumClipboard
- Method Detail
  - setSecurityContext
```
public void setSecurityContext(java.security.AccessControlContext acc)
```
    Description copied from interface: TKClipboard
    
    This method is used to set security context of the Stage.
    
    Specified by:
    
    setSecurityContext in interface TKClipboard
  - getAccessControlContext
```
private java.security.AccessControlContext getAccessControlContext()
```
  - getClipboardInstance
```
public static QuantumClipboard getClipboardInstance(ClipboardAssistance assistant)
```
    Gets an instance of QuantumClipboard for the given assistant. This may be a new instance after each call.
    
    Parameters:
    
    assistant -
    
    Returns:
  - getCurrentDragboard
```
static ClipboardAssistance getCurrentDragboard()
```
  - releaseCurrentDragboard
```
static void releaseCurrentDragboard()
```
  - getDragboardInstance
```
public static QuantumClipboard getDragboardInstance(ClipboardAssistance assistant,
                                                    boolean isDragSource)
```
    Gets an instance of QuantumClipboard for the given assistant for usage as dragboard during drag and drop. It doesn't flush the data implicitly and caches them until flush() is called. This may be a new instance after each call.
    
    Parameters:
    
    assistant -
    
    Returns:
  - transferModesToClipboardActions
```
public static int transferModesToClipboardActions(java.util.Set<TransferMode> tms)
```
  - setSupportedTransferMode
```
public void setSupportedTransferMode(java.util.Set<TransferMode> tm)
```
  - clipboardActionsToTransferModes
```
public static java.util.Set<TransferMode> clipboardActionsToTransferModes(int actions)
```
  - getTransferModes
```
public java.util.Set<TransferMode> getTransferModes()
```
    Specified by:
    
    getTransferModes in interface TKClipboard
  - setDragView
```
public void setDragView(Image image)
```
    Description copied from interface: TKClipboard
    
    Sets the visual representation of data being transfered in a drag and drop gesture.
    
    Specified by:
    
    setDragView in interface TKClipboard
    
    Parameters:
    
    image - image to use for the drag view
  - setDragViewOffsetX
```
public void setDragViewOffsetX(double offsetX)
```
    Description copied from interface: TKClipboard
    
    Sets the x position of the cursor of the drag view image.
    
    Specified by:
    
    setDragViewOffsetX in interface TKClipboard
    
    Parameters:
    
    offsetX - x position of the cursor over the image
  - setDragViewOffsetY
```
public void setDragViewOffsetY(double offsetY)
```
    Description copied from interface: TKClipboard
    
    Sets the y position of the cursor of the drag view image.
    
    Specified by:
    
    setDragViewOffsetY in interface TKClipboard
    
    Parameters:
    
    offsetY - x position of the cursor over the image
  - getDragView
```
public Image getDragView()
```
    Description copied from interface: TKClipboard
    
    Gets the image used as a drag view.
    
    Specified by:
    
    getDragView in interface TKClipboard
    
    Returns:
    
    the image used as a drag view
  - getDragViewOffsetX
```
public double getDragViewOffsetX()
```
    Description copied from interface: TKClipboard
    
    Gets the x position of the cursor of the drag view image.
    
    Specified by:
    
    getDragViewOffsetX in interface TKClipboard
    
    Returns:
    
    x position of the cursor over the image
  - getDragViewOffsetY
```
public double getDragViewOffsetY()
```
    Description copied from interface: TKClipboard
    
    Gets the y position of the cursor of the drag view image.
    
    Specified by:
    
    getDragViewOffsetY in interface TKClipboard
    
    Returns:
    
    y position of the cursor over the image
  - close
```
public void close()
```
  - flush
```
public void flush()
```
  - getContent
```
public java.lang.Object getContent(DataFormat dataFormat)
```
    Description copied from interface: TKClipboard
    
    Returns the content stored in this clipboard of the given type, or null if there is no content with this type.
    
    Specified by:
    
    getContent in interface TKClipboard
    
    Returns:
    
    The content associated with this type, or null if there is none
  - convertObjectToImage
```
private static Image convertObjectToImage(java.lang.Object obj)
```
  - readImage
```
private Image readImage()
```
  - parseIMG
```
private java.lang.String parseIMG(java.lang.Object data)
```
  - placeImage
```
private boolean placeImage(Image image)
```
  - getContentTypes
```
public java.util.Set<DataFormat> getContentTypes()
```
    Description copied from interface: TKClipboard
    
    Gets the set of DataFormat types on this Clipboard instance which have associated data registered on the clipboard. This set will always be non-null and immutable. If the Clipboard is subsequently modifed, this returned set is not updated.
    
    Specified by:
    
    getContentTypes in interface TKClipboard
    
    Returns:
    
    A non-null immutable set of content types.
  - hasContent
```
public boolean hasContent(DataFormat dataFormat)
```
    Description copied from interface: TKClipboard
    
    Tests whether there is any content on this clipboard of the given DataFormat type.
    
    Specified by:
    
    hasContent in interface TKClipboard
    
    Returns:
    
    true if there is content on this clipboard for this type
  - prepareImage
```
private static java.nio.ByteBuffer prepareImage(Image image)
```
  - prepareOffset
```
private static java.nio.ByteBuffer prepareOffset(double offsetX,
                                                 double offsetY)
```
  - putContentToPeer
```
private boolean putContentToPeer(Pair<DataFormat,java.lang.Object>... content)
```
  - putContent
```
public boolean putContent(Pair<DataFormat,java.lang.Object>... content)
```
    Description copied from interface: TKClipboard
    
    Puts the specified content onto the clipboard. Note that all existing content is cleared from the clipboard prior to the specified content being added. A NullPointerException is thrown if either the DataFormat or the Object data in the content Pair is null.
    
    Specified by:
    
    putContent in interface TKClipboard
    
    Parameters:
    
    content - The content to put on the clipboard.
    
    Returns:
    
    True if successful, false if the content fails to be added.
  - clearCache
```
private void clearCache()
```
  - clearDragView
```
private void clearDragView()
```

Class QuantumClipboard

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

systemAssistant

accessContext

isCaching

dataCache

transferModesCache

dragImage

dragOffsetX

dragOffsetY

currentDragboard

findTagIMG

Constructor Detail

QuantumClipboard

Method Detail

setSecurityContext

getAccessControlContext

getClipboardInstance

getCurrentDragboard

releaseCurrentDragboard

getDragboardInstance

transferModesToClipboardActions

setSupportedTransferMode

clipboardActionsToTransferModes

getTransferModes

setDragView

setDragViewOffsetX

setDragViewOffsetY

getDragView

getDragViewOffsetX

getDragViewOffsetY

close

flush

getContent

convertObjectToImage

readImage

parseIMG

placeImage

getContentTypes

hasContent

prepareImage

prepareOffset

putContentToPeer

putContent

clearCache

clearDragView