Class ClipboardHistory

java.lang.Object

org.fife.ui.rtextarea.ClipboardHistory

public final class ClipboardHistory
extends Object

Listens for cuts and copies from instances of RTextArea. This is used for the "clipboard history" shortcut (Ctrl+Shift+V by default).

Note that this class does not listen for all events on the system clipboard, because that functionality is pretty fragile. See https://stackoverflow.com/questions/5484927/listen-to-clipboard-changes-check-ownership for more information.

Version:

1.0

Author:

Robert Futrell

Method Summary

Modifier and Type	Method	Description
void	add(String str)	Adds an entry to the clipboard history.
static ClipboardHistory	get()	Returns the singleton instance of this class, lazily creating it if necessary.
List<String>	getHistory()	Returns the clipboard history, in most-recently-used order.
int	getMaxSize()	Returns the maximum number of clipboard values remembered.
void	setMaxSize(int maxSize)	Sets the maximum number of clipboard values remembered.

Methods inherited from class Object

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

Method Details

add

public void add(String str)

Adds an entry to the clipboard history.

Parameters:

str - The text to add.

See Also:

• getHistory()

get

public static ClipboardHistory get()

Returns the singleton instance of this class, lazily creating it if necessary.

This method should only be called on the EDT.

Returns:

The singleton instance of this class.

getHistory

public List<String> getHistory()

Returns the clipboard history, in most-recently-used order.

Returns:

The clipboard history.

getMaxSize

public int getMaxSize()

Returns the maximum number of clipboard values remembered.

Returns:

The maximum number of clipboard values remembered.

See Also:

• setMaxSize(int)

setMaxSize

public void setMaxSize(int maxSize)

Sets the maximum number of clipboard values remembered.

Parameters:

maxSize - The maximum number of clipboard values to remember.

Throws:

IllegalArgumentException - If maxSize is not greater than zero.

See Also:

• getMaxSize()