XMLClipboard (XMLmind XML Editor Java[tm] API)

java.lang.Object
- com.xmlmind.xmledit.edit.XMLClipboard

All Implemented Interfaces:

ClipboardOwner
```
public final class XMLClipboard
extends Object
implements ClipboardOwner
```
This utility class caches the XML and plain text content copied to the clipboard by the XML editor or by external applications. The XML content is cached in both string form and parsed form (array of Nodes).
This class is needed because the clipboard is queried each time the editing context of the XML editor changes (which is: very often).

See Also:

ContextChangeListener, MarkManager.addContextChangeListener(com.xmlmind.xmledit.edit.ContextChangeListener)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class XMLClipboard.Info
Information about the contents of the XMLClipboard.

Nested Classes
Modifier and Type	Class and Description
`static class`	`XMLClipboard.Info` Information about the contents of the XMLClipboard.

Field Summary

Fields
Modifier and Type	Field and Description
`Clipboard`	`clipboard`
`static Node[]`	`PLAIN_TEXT_NODES` A ready-to-use fixed piece of plain text wrapped as an array of XML nodes.
`static String`	`XML_CLIPBOARD_CONTENT_PROPERTY` The name of the property which can be observed by registered `PropertyChangeListener`s.

Constructor Summary

Constructors
Constructor and Description

XMLClipboard(Clipboard clipboard)
Constructs a clipboard cache delegating to specified clipboard.

Constructors
Constructor and Description
`XMLClipboard(Clipboard clipboard)` Constructs a clipboard cache delegating to specified clipboard.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Adds a property change listener to the listener list.
`Node[]`	`copyNodes(String s)` Returns a copy of the parsed form of the contents of the clipboard.
`String`	`get()` Returns the string contained in the system clipboard if any; `null` otherwise.
`XMLClipboard.Info`	`getInfo(XMLClipboard.Info info)` Returns information about the current content of the XMLClipboard.
`Node[]`	`getNodes(String s)` Returns the parsed form of the contents of the clipboard.
`static String`	`getPlainText(Node[] nodes)` Returns a string if specified nodes are just a wrapper around plain text; `null` if specified nodes are actual XML nodes.
`PropertyChangeListener[]`	`getPropertyChangeListeners()` Returns an array of all the registered property change listeners.
`static XMLClipboard`	`getSharedInstance()` Returns the shared instance of XMLClipboard.
`static boolean`	`isPlainText(Node[] nodes)` Tests whether specified nodes are just a wrapper around plain text.
`void`	`lostOwnership(Clipboard clipboard, Transferable contents)`
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes a property change listener from the listener list.
`boolean`	`set(String s)` Copies specified string to the clipboard.
`static void`	`setSharedInstance(XMLClipboard clipboard)` Installs the shared instance of XMLClipboard.
`void`	`startCaching()` startCaching/`stopCaching()` blocks can be used to cache the string returned by `get()` when the application knows that a sequence of invocations of get is likely to happen in a piece of code (example: 3 invocations of get in the next 10ms).
`void`	`stopCaching()` See `stopCaching()`.
`static Node[]`	`wrapPlainText(String s)` Converts specified plain text to an array of XML nodes.

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

- Field Detail
  - PLAIN_TEXT_NODES
```
public static final Node[] PLAIN_TEXT_NODES
```
    A ready-to-use fixed piece of plain text wrapped as an array of XML nodes.
    May be used to perform some tests (see implementation of TextEditor).
  - XML_CLIPBOARD_CONTENT_PROPERTY
```
public static final String XML_CLIPBOARD_CONTENT_PROPERTY
```
    The name of the property which can be observed by registered PropertyChangeListeners.
    
    See Also:
    
    addPropertyChangeListener(java.beans.PropertyChangeListener), Constant Field Values
  - clipboard
```
public final Clipboard clipboard
```
- Constructor Detail
  - XMLClipboard
```
public XMLClipboard(Clipboard clipboard)
```
    Constructs a clipboard cache delegating to specified clipboard.
    
    Parameters:
    
    clipboard - the clipboard being used; null to specify the system clipboard
- Method Detail
  - isPlainText
```
public static boolean isPlainText(Node[] nodes)
```
    Tests whether specified nodes are just a wrapper around plain text.
    
    See Also:
    
    getPlainText(com.xmlmind.xml.doc.Node[]), wrapPlainText(java.lang.String)
  - getPlainText
```
public static String getPlainText(Node[] nodes)
```
    Returns a string if specified nodes are just a wrapper around plain text; null if specified nodes are actual XML nodes.
    
    See Also:
    
    isPlainText(com.xmlmind.xml.doc.Node[]), wrapPlainText(java.lang.String)
  - wrapPlainText
```
public static Node[] wrapPlainText(String s)
```
    Converts specified plain text to an array of XML nodes.
    Note that s characters are not filtered, and this, because the returned nodes are not intended to be inserted as is in an XML document.
    
    See Also:
    
    isPlainText(com.xmlmind.xml.doc.Node[]), getPlainText(com.xmlmind.xml.doc.Node[]), PLAIN_TEXT_NODES
  - set
```
public boolean set(String s)
```
    Copies specified string to the clipboard.
    
    Parameters:
    
    s - string to be copied to the clipboard.
    A string which starts with "<?xml " is considered to be well-formed XML (though the well-formedness is not checked here).
    May be null in which case the internal state of this XMLClipboard is simply cleared.
    
    Returns:
    
    true if the string has been successfully copied to the clipboard; false otherwise (system clipboard busy)
  - get
```
public String get()
```
    Returns the string contained in the system clipboard if any; null otherwise.
  - startCaching
```
public void startCaching()
```
    startCaching/stopCaching() blocks can be used to cache the string returned by get() when the application knows that a sequence of invocations of get is likely to happen in a piece of code (example: 3 invocations of get in the next 10ms).
    This is just an optimization for very special cases which has been added because retrieving a string copied to the system clipboard by an external application may be quite slow. Of course, the methods of this class works without having to use startCaching/stopCaching blocks.
    Note that startCaching/stopCaching blocks can be nested but make sure that there is a invocation of stopCaching for each invocation of startCaching.
  - stopCaching
```
public void stopCaching()
```
    See stopCaching().
  - getInfo
```
public XMLClipboard.Info getInfo(XMLClipboard.Info info)
```
    Returns information about the current content of the XMLClipboard.
    
    Parameters:
    
    info - the information is stored in this object. May be null.
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Adds a property change listener to the listener list.
    The listener may observe a unique property: XML_CLIPBOARD_CONTENT_PROPERTY, which represents the contents of this XMLClipboard.
    Note that in the event received by the listeners, PropertyChangeEvent.getOldValue() and PropertyChangeEvent.getNewValue() both always return a non-null XMLClipboard.Info object.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
    Removes a property change listener from the listener list.
  - getPropertyChangeListeners
```
public PropertyChangeListener[] getPropertyChangeListeners()
```
    Returns an array of all the registered property change listeners.
  - lostOwnership
```
public void lostOwnership(Clipboard clipboard,
                          Transferable contents)
```
    Specified by:
    
    lostOwnership in interface ClipboardOwner
  - getNodes
```
public Node[] getNodes(String s)
```
    Returns the parsed form of the contents of the clipboard. Returns a node wrapper around plain text if the clipboard contains plain text and not well-formed XML.
    The returned array of nodes must not be modified by client code. It is suitable to perform some tests (see implementation of ElementEditor, TextEditor).
    
    Parameters:
    
    s - the string for which a parsed form is to be returned. Pass null to specify the contents of the clipboard.
    
    See Also:
    
    get(), copyNodes(java.lang.String), isPlainText(com.xmlmind.xml.doc.Node[]), getPlainText(com.xmlmind.xml.doc.Node[])
  - copyNodes
```
public Node[] copyNodes(String s)
```
    Returns a copy of the parsed form of the contents of the clipboard. Returns a node wrapper around plain text if the clipboard contains plain text and not well-formed XML.
    
    Parameters:
    
    s - the string for which a parsed form is to be returned. Pass null to specify the contents of the clipboard.
    
    See Also:
    
    getNodes(java.lang.String), isPlainText(com.xmlmind.xml.doc.Node[]), getPlainText(com.xmlmind.xml.doc.Node[])
  - setSharedInstance
```
public static final void setSharedInstance(XMLClipboard clipboard)
```
    Installs the shared instance of XMLClipboard.
    
    See Also:
    
    getSharedInstance()
  - getSharedInstance
```
public static final XMLClipboard getSharedInstance()
```
    Returns the shared instance of XMLClipboard.
    Creates and installs one if setSharedInstance(com.xmlmind.xmledit.edit.XMLClipboard) has never been invoked or has been set to null.

Class XMLClipboard

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PLAIN_TEXT_NODES

XML_CLIPBOARD_CONTENT_PROPERTY

clipboard

Constructor Detail

XMLClipboard

Method Detail

isPlainText

getPlainText

wrapPlainText

set

get

startCaching

stopCaching

getInfo

addPropertyChangeListener

removePropertyChangeListener

getPropertyChangeListeners

lostOwnership

getNodes

copyNodes

setSharedInstance

getSharedInstance