Spec-Zone.ru › OpenJDK 8

Класс Clipboard

  • java.lang.Object
    • java.awt.datatransfer.Clipboard

public class Clipboard
extends Object

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

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

См. также:
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)

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

Методы, унаследованные от класса 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)

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

См. также:
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(java.awt.datatransfer.FlavorListener), getFlavorListeners(), FlavorListener, FlavorEvent

removeFlavorListener

public void removeFlavorListener(FlavorListener listener)

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

Параметры:
listener - слушатель, который нужно удалить
См.:
1.5
См. также:
addFlavorListener(java.awt.datatransfer.FlavorListener), getFlavorListeners(), FlavorListener, FlavorEvent

getFlavorListeners

public FlavorListener[] getFlavorListeners()

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

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

© 1993, 2020, 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.

Spec-Zone.ru

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