Spec-Zone.ru › OpenJDK 25

Класс Clipboard

java.lang.Object
java.awt.datatransfer.Clipboard
public class Clipboard extends Object
Класс, реализующий механизм передачи данных с помощью операций вырезания, копирования и вставки.

FlavorListenerы могут быть зарегистрированы в экземпляре класса Clipboard, чтобы получать уведомления об изменениях набора DataFlavorов, доступных в этом буфере обмена (см. addFlavorListener(FlavorListener)).

Начиная с:
1.1
См. также:
  • Toolkit.getSystemClipboard()
  • Toolkit.getSystemSelection()

Краткое описание полей

Модификатор и тип Поле Описание
protected Transferable contents
Содержимое буфера обмена.
protected ClipboardOwner owner
Владелец буфера обмена.

Краткое описание конструкторов

Конструктор Описание
Clipboard(String name)
Создает объект буфера обмена.

Краткое описание методов

Модификатор и тип Метод Описание
void addFlavorListener(FlavorListener listener)
Регистрирует указанный FlavorListener для получения FlavorEventов из этого буфера обмена.
DataFlavor[] getAvailableDataFlavors()
Возвращает массив DataFlavorов, в которых можно предоставить текущее содержимое этого буфера обмена.
Transferable getContents(Object requestor)
Возвращает передаваемый объект, представляющий текущее содержимое буфера обмена.
Object getData(DataFlavor flavor)
Возвращает объект, представляющий текущее содержимое этого буфера обмена в указанном DataFlavorе.
FlavorListener[] getFlavorListeners()
Возвращает массив всех FlavorListenerов, зарегистрированных в данный момент в этом Clipboardе.
String getName()
Возвращает имя этого объекта буфера обмена.
boolean isDataFlavorAvailable(DataFlavor flavor)
Возвращает, можно ли предоставить текущее содержимое этого буфера обмена в указанном DataFlavorе.
void removeFlavorListener(FlavorListener listener)
Удаляет указанный FlavorListener, чтобы он больше не получал FlavorEventы из этого Clipboardа.
void setContents(Transferable contents, ClipboardOwner owner)
Устанавливает указанный передаваемый объект в качестве текущего содержимого буфера обмена и регистрирует указанного владельца буфера обмена как владельца нового содержимого.

Методы, объявленные в классе Object

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

Подробное описание полей

owner

protected ClipboardOwner owner
Владелец буфера обмена.

contents

protected Transferable contents
Содержимое буфера обмена.

Подробное описание конструкторов

Clipboard

public Clipboard(String name)
Создает объект буфера обмена.
Параметры:
name — для буфера обмена
См. также:
  • Toolkit.getSystemClipboard()

Подробное описание методов

getName

public String getName()
Возвращает имя этого объекта буфера обмена.
Возвращает:
имя этого объекта буфера обмена
См. также:
  • Toolkit.getSystemClipboard()

setContents

public void setContents(Transferable contents, ClipboardOwner owner)
Устанавливает указанный передаваемый объект в качестве текущего содержимого буфера обмена и регистрирует указанного владельца буфера обмена как владельца нового содержимого.

Если существует текущий владелец, отличный от аргумента owner, он получает уведомление о потере владения содержимым буфера обмена посредством вызова ClipboardOwner.lostOwnership() для этого владельца. Реализация setContents() может не вызывать lostOwnership() непосредственно из этого метода. Например, lostOwnership() может быть вызван позднее в другом потоке. То же относится к FlavorListenerам, зарегистрированным в этом буфере обмена.

Метод генерирует исключение IllegalStateException, если буфер обмена в данный момент недоступен. Например, на некоторых платформах системный буфер обмена недоступен, пока к нему обращается другое приложение.

Параметры:
contents — передаваемый объект, представляющий содержимое буфера обмена
owner — объект, которому принадлежит содержимое буфера обмена
Вызывает исключение:
IllegalStateException — если буфер обмена в данный момент недоступен
См. также:
  • Toolkit.getSystemClipboard()

getContents

public Transferable getContents(Object requestor)
Возвращает передаваемый объект, представляющий текущее содержимое буфера обмена. Если буфер обмена в данный момент пуст, возвращает null. Параметр Object requestor в настоящее время не используется. Метод генерирует исключение IllegalStateException, если буфер обмена в данный момент недоступен. Например, на некоторых платформах системный буфер обмена недоступен, пока к нему обращается другое приложение.
Параметры:
requestor — объект, запрашивающий данные буфера обмена (не используется)
Возвращает:
текущий передаваемый объект в буфере обмена
Вызывает исключение:
IllegalStateException — если буфер обмена в данный момент недоступен
См. также:
  • Toolkit.getSystemClipboard()

getAvailableDataFlavors

public DataFlavor[] getAvailableDataFlavors()
Возвращает массив DataFlavorов, в которых можно предоставить текущее содержимое этого буфера обмена. Если доступных DataFlavorов нет, этот метод возвращает массив нулевой длины.
Возвращает:
массив DataFlavorов, в которых можно предоставить текущее содержимое этого буфера обмена
Вызывает исключение:
IllegalStateException — если этот буфер обмена в данный момент недоступен
Начиная с:
1.5

isDataFlavorAvailable

public boolean isDataFlavorAvailable(DataFlavor flavor)
Возвращает, можно ли предоставить текущее содержимое этого буфера обмена в указанном DataFlavorе.
Параметры:
flavor — запрошенный DataFlavor для содержимого
Возвращает:
true, если текущее содержимое этого буфера обмена можно предоставить в указанном DataFlavorе; в противном случае — false
Вызывает исключение:
NullPointerException — если flavor равен null
IllegalStateException — если этот буфер обмена в данный момент недоступен
Начиная с:
1.5

getData

public Object getData(DataFlavor flavor) throws UnsupportedFlavorException, IOException
Возвращает объект, представляющий текущее содержимое этого буфера обмена в указанном DataFlavorе. Класс возвращаемого объекта определяется классом представления flavor.
Параметры:
flavor — запрошенный DataFlavor для содержимого
Возвращает:
объект, представляющий текущее содержимое этого буфера обмена в указанном DataFlavor
Вызывает исключение:
NullPointerException — если flavor равен null
IllegalStateException — если этот буфер обмена в данный момент недоступен
UnsupportedFlavorException — если запрошенный DataFlavor недоступен
IOException — если данные в запрошенном DataFlavorе невозможно получить
Начиная с:
1.5
См. также:
  • DataFlavor.getRepresentationClass()

addFlavorListener

public void addFlavorListener(FlavorListener listener)
Регистрирует указанный FlavorListener для получения FlavorEventов из этого буфера обмена. Если listener равен null, исключение не генерируется и никаких действий не выполняется.
Параметры:
listener — добавляемый слушатель
Начиная с:
1.5
См. также:
  • removeFlavorListener(FlavorListener)
  • getFlavorListeners()
  • FlavorListener
  • FlavorEvent

removeFlavorListener

public void removeFlavorListener(FlavorListener listener)
Удаляет указанный FlavorListener, чтобы он больше не получал FlavorEventы из этого Clipboardа. Этот метод ничего не делает и не генерирует исключение, если слушатель, указанный аргументом, ранее не был добавлен в этот Clipboard. Если listener равен null, исключение не генерируется и никаких действий не выполняется.
Параметры:
listener — удаляемый слушатель
Начиная с:
1.5
См. также:
  • addFlavorListener(FlavorListener)
  • getFlavorListeners()
  • FlavorListener
  • FlavorEvent

getFlavorListeners

public FlavorListener[] getFlavorListeners()
Возвращает массив всех FlavorListenerов, зарегистрированных в данный момент в этом Clipboardе.
Возвращает:
все FlavorListenerы этого буфера обмена или пустой массив, если в данный момент нет зарегистрированных слушателей
Начиная с:
1.5
См. также:
  • addFlavorListener(FlavorListener)
  • removeFlavorListener(FlavorListener)
  • FlavorListener
  • FlavorEvent

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и работающие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.datatransfer/java/awt/datatransfer/Clipboard.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API