Class Clipboard

    • Field Detail

      • contents

        protected Transferable contents
        Contents of the clipboard.
    • Method Detail

      • setContents

        public void setContents​(Transferable contents,
                                ClipboardOwner owner)
        Sets the current contents of the clipboard to the specified transferable object and registers the specified clipboard owner as the owner of the new contents.

        If there is an existing owner different from the argument owner, that owner is notified that it no longer holds ownership of the clipboard contents via an invocation of ClipboardOwner.lostOwnership() on that owner. An implementation of setContents() is free not to invoke lostOwnership() directly from this method. For example, lostOwnership() may be invoked later on a different thread. The same applies to FlavorListeners registered on this clipboard.

        The method throws IllegalStateException if the clipboard is currently unavailable. For example, on some platforms, the system clipboard is unavailable while it is accessed by another application.

        Parameters:
        contents - the transferable object representing the clipboard content
        owner - the object which owns the clipboard content
        Throws:
        IllegalStateException - if the clipboard is currently unavailable
        See Also:
        Toolkit.getSystemClipboard()
      • getContents

        public Transferable getContents​(Object requestor)
        Returns a transferable object representing the current contents of the clipboard. If the clipboard currently has no contents, it returns null. The parameter Object requestor is not currently used. The method throws IllegalStateException if the clipboard is currently unavailable. For example, on some platforms, the system clipboard is unavailable while it is accessed by another application.
        Parameters:
        requestor - the object requesting the clip data (not used)
        Returns:
        the current transferable object on the clipboard
        Throws:
        IllegalStateException - if the clipboard is currently unavailable
        See Also:
        Toolkit.getSystemClipboard()
      • getAvailableDataFlavors

        public DataFlavor[] getAvailableDataFlavors​()
        Returns an array of DataFlavors in which the current contents of this clipboard can be provided. If there are no DataFlavors available, this method returns a zero-length array.
        Returns:
        an array of DataFlavors in which the current contents of this clipboard can be provided
        Throws:
        IllegalStateException - if this clipboard is currently unavailable
        Since:
        1.5
      • isDataFlavorAvailable

        public boolean isDataFlavorAvailable​(DataFlavor flavor)
        Returns whether or not the current contents of this clipboard can be provided in the specified DataFlavor.
        Parameters:
        flavor - the requested DataFlavor for the contents
        Returns:
        true if the current contents of this clipboard can be provided in the specified DataFlavor; false otherwise
        Throws:
        NullPointerException - if flavor is null
        IllegalStateException - if this clipboard is currently unavailable
        Since:
        1.5
      • removeFlavorListener

        public void removeFlavorListener​(FlavorListener listener)
        Removes the specified FlavorListener so that it no longer receives FlavorEvents from this Clipboard. This method performs no function, nor does it throw an exception, if the listener specified by the argument was not previously added to this Clipboard. If listener is null, no exception is thrown and no action is performed.
        Parameters:
        listener - the listener to be removed
        Since:
        1.5
        See Also:
        addFlavorListener(java.awt.datatransfer.FlavorListener), getFlavorListeners(), FlavorListener, FlavorEvent