Spec-Zone.ru › OpenJDK 17

Класс Clipboard

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

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

Since:
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)
Возвращает значение true, если текущее содержимое этого буфера обмена может быть предоставлено в указанном DataFlavor.
void removeFlavorListener(FlavorListener listener)
Удаляет указанный FlavorListener, чтобы он больше не получал FlavorEvent из этого Clipboard.
void setContents(Transferable contents, ClipboardOwner owner)
Устанавливает текущее содержимое буфера обмена на указанный объект transferable и регистрирует указанного владельца буфера обмена в качестве владельца нового содержимого.

Методы, объявленные в классе java.lang.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ых форматов, в которых можно предоставить текущее содержимое этого буфера обмена
Исключения:
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(java.awt.datatransfer.FlavorListener)
  • getFlavorListeners()
  • FlavorListener
  • FlavorEvent

removeFlavorListener

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

getFlavorListeners

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

© 1993, 2021, 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/17/docs/api/java.datatransfer/java/awt/datatransfer/Clipboard.html

Spec-Zone.ru

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