Класс Clipboard

java.lang.Object

java.awt.datatransfer.Clipboard

public class Clipboard extends Object

Класс, реализующий механизм передачи данных с помощью операций вырезания/копирования/вставки.

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

Since:

1.1

См. также:

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

Модификатор и тип	Поле	Описание
`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)`	Устанавливает текущее содержимое буфера обмена в указанный объект, передающий, и регистрирует указанного владельца буфера обмена в качестве владельца нового содержимого.

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

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

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

owner

protected ClipboardOwner owner

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

protected Transferable contents

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

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

Clipboard

public Clipboard(String name)

Создаёт объект буфера обмена.

Параметры:

name - для буфера обмена

См. также:

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

getName

public String getName()

Возвращает имя этого объекта буфера обмена.

Возвращает:

имя этого объекта буфера обмена

См. также:

setContents

public void setContents(Transferable contents, ClipboardOwner owner)

Устанавливает текущее содержимое буфера обмена на указанный объект transferable и регистрирует указанного владельца буфера обмена как владельца нового содержимого.

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

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

Параметры:

contents - объект transferable, представляющий содержимое буфера обмена

owner - объект, владеющий содержимым буфера обмена

Выбрасывает:

IllegalStateException - если буфер обмена в настоящее время недоступен

См. также:

getContents

public Transferable getContents(Object requestor)

Возвращает объект transferable, представляющий текущее содержимое буфера обмена. Если буфер обмена в настоящее время не содержит содержимого, он возвращает null. Параметр requestor не используется в настоящее время. Метод выбрасывает IllegalStateException если буфер обмена в настоящее время недоступен. Например, на некоторых платформах системный буфер обмена недоступен во время доступа к нему другим приложением.

Параметры:

requestor - объект, запрашивающий данные буфера обмена (не используется)

Возвращает:

текущий объект transferable в буфере обмена

Выбрасывает:

IllegalStateException - если буфер обмена в настоящее время недоступен

См. также:

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

См. также:

addFlavorListener

public void addFlavorListener(FlavorListener listener)

Регистрирует указанного FlavorListener для получения FlavorEvent от этого буфера обмена. Если listener является null, исключение не выбрасывается и никаких действий не выполняется.

Параметры:

listener - добавляемый слушатель

С момента:

1.5

См. также:

removeFlavorListener

public void removeFlavorListener(FlavorListener listener)

Удаляет указанного FlavorListener , чтобы он больше не получал FlavorEvent от этого Clipboard. Этот метод не выполняет никаких функций и не выбрасывает исключение, если слушатель, указанный аргументом, ранее не был добавлен к этому Clipboard. Если listener является null, исключение не выбрасывается и никаких действий не выполняется.

Параметры:

listener - удаляемый слушатель

С момента:

1.5

См. также:

getFlavorListeners

public FlavorListener[] getFlavorListeners()

Возвращает массив всех FlavorListener , зарегистрированных в этом Clipboard.

Возвращает:

все FlavorListener этого буфера обмена или пустой массив, если слушатели не зарегистрированы

С момента:

1.5

См. также:

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