PdfBookmarkEditor

Наследование: java.lang.Object, com.aspose.pdf.facades.IVentureLicenseTarget, com.aspose.pdf.facades.Facade, com.aspose.pdf.facades.SaveableFacade

public final class PdfBookmarkEditor extends SaveableFacade

Представляет класс для работы с закладками файла PDF, включая создание, изменение, экспорт, импорт и удаление.

Конструкторы

КонструкторОписание
PdfBookmarkEditor()Инициализирует новый объект PdfBookmarkEditor.
PdfBookmarkEditor(IDocument document)Инициализирует новый объект PdfBookmarkEditor на основе документа.

Методы

МетодОписание
bindPdf(IDocument srcDoc)Инициализирует фасад.
bindPdf(InputStream srcStream)Инициализирует фасад.
bindPdf(InputStream srcStream, String password)Инициализирует фасад.
bindPdf(String srcFile)Инициализирует фасад.
bindPdf(String srcFile, String password)Инициализирует фасад.
close()Закройте экземпляр PdfBookmarkEditor и освободите ресурсы.
createBookmarkOfPage(String bookmarkName, int pageNumber)Создает закладку для указанной страницы.
createBookmarkOfPage(String[] bookmarkName, int[] pageNumber)Создает закладки для указанных страниц.
createBookmarks()Создает закладки для всех страниц.
createBookmarks(Bookmark bookmark)Создает указанную закладку в документе.
createBookmarks(Color color, boolean boldFlag, boolean italicFlag)Создайте закладки для всех страниц с заданным цветом и стилем (жирный, курсив).
deleteBookmarks()Удаляет все закладки документа PDF.
deleteBookmarks(String title)Удаляет закладку документа PDF.
dispose()Располагает фасад.
equals(Object arg0)
exportBookmarksToHtml(String inPdfFile, String outHtmlFile)Экспортирует закладки в файл HTML.
exportBookmarksToXML(OutputStream output)Экспортирует закладки в поток XML.
exportBookmarksToXML(String xmlFile)Экспортирует закладки в файл XML.
extractBookmarks()Извлекает из документа закладки всех уровней.
extractBookmarks(boolean upperLevel)Извлекает из документа закладки всех уровней.
extractBookmarks(Bookmark bookmark)Извлекает дочерние элементы закладки с заголовком, как в указанном bookamrk.
extractBookmarks(String title)Извлекает закладки с указанным заголовком.
extractBookmarksToHTML(String pdfFile, String cssFile)Экспортирует закладки в файл HTML.
getClass()
getDocument()Получает фасад документа, над которым работает.
hashCode()
importBookmarksWithXML(InputStream stream)Импортирует закладки в документ из файла XML.
importBookmarksWithXML(String xmlFile)Импортирует закладки в документ из файла XML.
modifyBookmarks(String sTitle, String dTitle)Изменяет название закладки в соответствии с указанным названием закладки.
notify()
notifyAll()
save(OutputStream destStream)Сохраняет документ PDF в указанный поток.
save(String destFile)Сохраняет документ PDF в указанный файл.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

PdfBookmarkEditor()

public PdfBookmarkEditor()

Инициализирует новый объект PdfBookmarkEditor.

PdfBookmarkEditor(IDocument document)

public PdfBookmarkEditor(IDocument document)

Инициализирует новый объект PdfBookmarkEditor на основе документа.

Параметры:

ПараметрТипОписание
documentIDocumentДокумент пдф.

bindPdf(IDocument srcDoc)

public void bindPdf(IDocument srcDoc)

Инициализирует фасад.

Параметры:

ПараметрТипОписание
srcDocIDocumentОбъект Документ.

bindPdf(InputStream srcStream)

public void bindPdf(InputStream srcStream)

Инициализирует фасад.

Параметры:

ПараметрТипОписание
srcStreamjava.io.InputStreamПоток файла PDF.

bindPdf(InputStream srcStream, String password)

public void bindPdf(InputStream srcStream, String password)

Инициализирует фасад.

Параметры:

ПараметрТипОписание
srcStreamjava.io.InputStreamПоток файла PDF.
passwordjava.lang.StringПароль документа PDF.

bindPdf(String srcFile)

public void bindPdf(String srcFile)

Инициализирует фасад.

Параметры:

ПараметрТипОписание
srcFilejava.lang.StringPDF-файл.

bindPdf(String srcFile, String password)

public void bindPdf(String srcFile, String password)

Инициализирует фасад.

Параметры:

ПараметрТипОписание
srcFilejava.lang.StringPDF-файл
passwordjava.lang.StringПароль документа PDF.

close()

public void close()

Закройте экземпляр PdfBookmarkEditor и освободите ресурсы.

createBookmarkOfPage(String bookmarkName, int pageNumber)

public void createBookmarkOfPage(String bookmarkName, int pageNumber)

Создает закладку для указанной страницы.


PdfBookmarkEditor editor = new PdfBookmarkEditor();
 editor.bindPdf("example.pdf");
 editor.createBookmarkOfPage("bookmark for page 1", 1);
 editor.save("example_out.pdf");

Параметры:

ПараметрТипОписание
bookmarkNamejava.lang.StringУказанное имя закладки.
pageNumberintУказанная целевая страница.

createBookmarkOfPage(String[] bookmarkName, int[] pageNumber)

public void createBookmarkOfPage(String[] bookmarkName, int[] pageNumber)

Создает закладки для указанных страниц.


PdfBookmarkEditor editor = new PdfBookmarkEditor();
 editor.bindPdf("example.pdf");
 editor.createBookmarkOfPage("bookmark for page 1", 1);
 editor.save("example_out.pdf");

Параметры:

ПараметрТипОписание
bookmarkNamejava.lang.String[]Массив заголовков закладок.
pageNumberint[]Массив целевых страниц закладок.

createBookmarks()

public void createBookmarks()

Создает закладки для всех страниц.


PdfBookmarkEditor editor = new PdfBookmarkEditor();
 editor.bindPdf("example.pdf");
 editor.createBookmarks();
 editor.save("example_out.pdf");

createBookmarks(Bookmark bookmark)

public void createBookmarks(Bookmark bookmark)

Создает указанную закладку в документе. Метод может быть использован для формирования иерархии вложенных закладок.


PdfBookmarkEditor editor = new PdfBookmarkEditor();
  editor.bindPdf("example.pdf");
  Bookmark bm1=new Bookmark();
  bm1.setPageNumber(1);
  bm1.setTitle("First child");
 	Bookmark bm2=new Bookmark();
 	bm2.setPageNumber(2);
  bm2.setTitle("Second child");
  Bookmark bm=new Bookmark();
  bm.setAction=(GoTo");
  bm.setPageNumber(1);
  bm.setTitle("Parent");
  Bookmarks bms=new Bookmarks();
  bms.add(bm1);
  bms.add(bm2);
  bm.setChildItem(bms);
  editor.setCreateBookmarks(bm);
  editor.save("example_out.pdf");

Параметры:

ПараметрТипОписание
bookmarkBookmarkЗакладка будет добавлена в документ.

createBookmarks(Color color, boolean boldFlag, boolean italicFlag)

public void createBookmarks(Color color, boolean boldFlag, boolean italicFlag)

Создайте закладки для всех страниц с заданным цветом и стилем (жирный, курсив).


PdfBookmarkEditor editor = new PdfBookmarkEditor();
 editor.bindPdf("example.pdf");
 editor.createBookmarks(System.Drawing.Color.Red, true, true);
 editor.save("example_out.pdf");

Параметры:

ПараметрТипОписание
colorjava.awt.ColorЦвет заголовка.
boldFlagbooleanФлаг смелой атрибуции.
italicFlagbooleanФлаг курсивной атрибуции.

deleteBookmarks()

public void deleteBookmarks()

Удаляет все закладки документа PDF.


PdfBookmarkEditor editor = new PdfBookmarkEditor();
 editor.bindPdf("example.pdf");
 editor.deleteBookmarks();
 editor.save("example_out.pdf");

deleteBookmarks(String title)

public void deleteBookmarks(String title)

Удаляет закладку документа PDF.


PdfBookmarkEditor editor = new PdfBookmarkEditor();
 editor.bindPdf("example.pdf");
 editor.deleteBookmarks("existing bookmark title");
 editor.save("example_out.pdf");

Параметры:

ПараметрТипОписание
titlejava.lang.StringНазвание закладки удалено.

dispose()

public void dispose()

Располагает фасад.

Этот метод устарел, вместо него используйте close().

equals(Object arg0)

public boolean equals(Object arg0)

Параметры:

ПараметрТипОписание
arg0java.lang.Object

Возвращает: логический

exportBookmarksToHtml(String inPdfFile, String outHtmlFile)

public static void exportBookmarksToHtml(String inPdfFile, String outHtmlFile)

Экспортирует закладки в файл HTML.


PdfBookmarkEditor.extractBookmarksToHTML("example.pdf", "bookmarks.html");

Параметры:

ПараметрТипОписание
inPdfFilejava.lang.StringВведите PDF-файл, закладки которого будут экспортированы.
outHtmlFilejava.lang.StringВыходной HTML-файл

exportBookmarksToXML(OutputStream output)

public void exportBookmarksToXML(OutputStream output)

Экспортирует закладки в поток XML.

Параметры:

ПараметрТипОписание
outputjava.io.OutputStreamВыходной поток, в котором будут храниться данные.

exportBookmarksToXML(String xmlFile)

public void exportBookmarksToXML(String xmlFile)

Экспортирует закладки в файл XML.


PdfBookmarkEditor editor = new PdfBookmarkEditor();
 editor.bindPdf("example.pdf");
 editor.exportBookmarksToXML("bookmarks.xml");

Параметры:

ПараметрТипОписание
xmlFilejava.lang.StringВыходной XML-файл.

extractBookmarks()

public Bookmarks extractBookmarks()

Извлекает из документа закладки всех уровней.


PdfBookmarkEditor editor = new PdfBookmarkEditor();
 editor.bindPdf("example.pdf");
 Bookmarks bms = editor.ExtractBookmarks();
 for(Bookmark bm : bms)
     System.out.println(bm.Title);

Возвращает: Bookmarks - Коллекция закладок всех закладок, существующих в документе.

extractBookmarks(boolean upperLevel)

public Bookmarks extractBookmarks(boolean upperLevel)

Извлекает из документа закладки всех уровней.

Параметры:

ПараметрТипОписание
upperLevelbooleanЕсли true, извлекаются только закладки верхнего уровня. В противном случае рекурсивно извлекает все закладки.

Возвращает: Bookmarks - Список извлеченных закладок.

extractBookmarks(Bookmark bookmark)

public Bookmarks extractBookmarks(Bookmark bookmark)

Извлекает дочерние элементы закладки с заголовком, как в указанном bookamrk.


PdfBookmarkEditor editor = new PdfBookmarkEditor();
 editor.bindPdf("example.pdf");
 Bookmark bookmark = new Bookmark();
 bookmark.setTitle ( "Title");
 Bookmarks bms = editor.ExtractBookmarks(bookmark);
 for(Bookmark bm : ```
(Iterable)
```bms)
     System.out.println(bm.Title);

Параметры:

ПараметрТипОписание
bookmarkBookmarkУказанный букамрк.

Возвращает: Bookmarks - Коллекция закладок с дочерними закладками.

extractBookmarks(String title)

public Bookmarks extractBookmarks(String title)

Извлекает закладки с указанным заголовком.


PdfBookmarkEditor editor = new PdfBookmarkEditor();
  editor.bindPdf("example.pdf");
 	Bookmarks bms = editor.ExtractBookmarks("Title");
  for(Bookmark bm : ```
(Iterable)
```bms)
      System.out.println(bm.Title);

Параметры:

ПараметрТипОписание
titlejava.lang.StringИзвлеченное название элемента.

Возвращает: Bookmarks - В коллекции объектов закладок есть элементы с одинаковым названием.

extractBookmarksToHTML(String pdfFile, String cssFile)

public void extractBookmarksToHTML(String pdfFile, String cssFile)

Экспортирует закладки в файл HTML.


PdfBookmarkEditor editor = new PdfBookmarkEditor();
 editor.extractBookmarksToHTML("example.pdf", null);

Параметры:

ПараметрТипОписание
pdfFilejava.lang.StringФайл PDF, закладки которого будут экспортированы.
cssFilejava.lang.StringФайл CSS для отображения HTML-файла может быть нулевым.

getClass()

public final native Class<?> getClass()

Возвращает: java.lang.Класс

getDocument()

public IDocument getDocument()

Получает фасад документа, над которым работает.

Возвращает: IDocument - элемент IDocument

hashCode()

public native int hashCode()

Возвращает: инт

importBookmarksWithXML(InputStream stream)

public void importBookmarksWithXML(InputStream stream)

Импортирует закладки в документ из файла XML.

Параметры:

ПараметрТипОписание
streamjava.io.InputStreamПоток с данными закладок.

importBookmarksWithXML(String xmlFile)

public void importBookmarksWithXML(String xmlFile)

Импортирует закладки в документ из файла XML.


PdfBookmarkEditor editor = new PdfBookmarkEditor();
 editor.bindPdf("example.pdf");
 editor.importBookmarksWithXML("bookmarks.xml");
 editor.save("example_out.pdf");

Параметры:

ПараметрТипОписание
xmlFilejava.lang.StringXML-файл, содержащий список закладок.

modifyBookmarks(String sTitle, String dTitle)

public void modifyBookmarks(String sTitle, String dTitle)

Изменяет название закладки в соответствии с указанным названием закладки.


PdfBookmarkEditor editor = new PdfBookmarkEditor();
 editor.bindPdf("example.pdf");
 editor.modifyBookmarks("existing bookmark title", "new bookmark title");
 editor.save("example_out.pdf");

Параметры:

ПараметрТипОписание
sTitlejava.lang.StringЗаголовок исходной закладки.
dTitlejava.lang.StringИзменено название закладки.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

save(OutputStream destStream)

public void save(OutputStream destStream)

Сохраняет документ PDF в указанный поток.

Параметры:

ПараметрТипОписание
destStreamjava.io.OutputStreamЦелевой поток.

save(String destFile)

public void save(String destFile)

Сохраняет документ PDF в указанный файл.

Параметры:

ПараметрТипОписание
destFilejava.lang.StringФайл назначения.

toString()

public String toString()

Возвращает: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Параметры:

ПараметрТипОписание
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Параметры:

ПараметрТипОписание
arg0long
arg1int