TextFragment
Наследование: java.lang.Object, com.aspose.pdf.BaseParagraph
public class TextFragment extends BaseParagraph
Представляет собой фрагмент текста Pdf.
The example demonstrates how to find text on the first PDF document page and replace the text and it's font.
// Открыть документ
Document doc = new Document("D:\\Tests\\input.pdf");
// Найти шрифт, который будет использоваться для изменения шрифта текста документа
Font font = FontRepository.findFont("Arial");
// Создайте объект TextFragmentAbsorber, чтобы найти все вхождения текста «hello world».
TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world");
// Принять поглотитель для первой страницы
doc.getPages().get(1).accept(absorber);
// Изменить текст и шрифт первого вхождения текста
absorber.getTextFragments().get_Item(1).setText ( "hi world");
absorber.getTextFragments().get_Item(1).getTextState().setFont ( font);
// Сохранить документ
doc.save("D:\\Tests\\output.pdf");
In a few words, ```
TextFragment
``` object contains list of ```
TextSegment
``` objects.
In details: Text of pdf document in ```
com.aspose.pdf
``` is represented by two basic objects:
Фрагмент текста
and
Текстовый сегмент
context-dependent.
Let's consider following scenario. User searches text "hello world" to operate with it, change
it's properties, look etc.
Document doc = new Document(docFile);
TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world");
doc.getPages().get(1).accept(absorber);
Физически представление текста в формате PDF очень сложно. Текст «hello world» может состоять из нескольких физически независимых текстовых сегментов. Текстовая модель Aspose.Pdf в основном устанавливает, что объект TextFragment предоставляет единый набор логических операций над набором физических объектов TextSegment, которые представляют запрос пользователя. В сценарии текстового поиска TextFragment является логическим текстовым представлением «привет, мир», а коллекция объектов TextSegment представляет все физические сегменты, которые создают текстовый объект «привет, мир». Итак, TextFragment близок к логическому текстовому представлению. А TextSegment близок к физическому текстовому представлению. Очевидно, что каждый объект TextSegment может иметь свой собственный шрифт, цвет, свойства позиционирования. TextFragment предоставляет простой способ изменить текст с помощью его свойств: установить шрифт, установить размер шрифта, установить цвет шрифта и т. д. При этом объекты TextSegment доступны, и пользователи могут работать с объектами TextSegment независимо.
Обратите внимание, что изменение свойств TextFragment может привести к изменению внутренней коллекции Segments, поскольку TextFragment является агрегатным объектом и может переупорядочивать внутренние сегменты или объединять их в один сегмент. Если вы хотите оставить коллекцию Segments без изменений, измените внутренние сегменты по отдельности.
Конструкторы
| Конструктор | Описание |
|---|---|
| TextFragment() | Инициализирует новый экземпляр объекта TextFragment. |
| TextFragment(TabStops tabStops) | Инициализирует новый экземпляр объекта TextFragment с предопределенными позициями TabStops. |
| TextFragment(String text) | Создает объект TextFragment с одним объектом TextSegment внутри. |
| TextFragment(String text, TabStops tabStops) | Создает объект TextFragment с одним объектом TextSegment внутри и предопределенными позициями TabStops. |
Методы
| Метод | Описание |
|---|---|
| cloneWithSegments() | Клонируйте фрагмент со всеми сегментами. |
| deepClone() | Клонируйте фрагмент. |
| equals(Object arg0) | |
| getBaselinePosition() | Получает текстовую позицию для текста, представленного объектом TextFragment. |
| getClass() | |
| getEndNote() | Получает примечание в конце абзаца. |
| getFootNote() | Получает сноску абзаца. |
| getForm() | Получает объект формы, содержащий TextFragment |
| Значение может быть нулевым, если объект TextFragment не принадлежит форме. | |
| getHorizontalAlignment() | Получает горизонтальное выравнивание текстового фрагмента. |
| getHyperlink() | Получает гиперссылку фрагмента (для генератора pdf). |
| getMargin() | Получает внешнее поле для абзаца (для создания pdf) |
| getPage() | Получает страницу, содержащую TextFragment |
| Значение может быть нулевым, если объект TextFragment не принадлежит ни одной странице. | |
| getPosition() | Получает текстовую позицию для текста, представленного объектом TextFragment. |
| getRectangle() | Получает прямоугольник TextFragment |
| getReplaceOptions() | Получает параметры замены текста. |
| getSegments() | Получает текстовые сегменты для текущего TextFragment . |
| getText() | Получает строковый текстовый объект, который представляет объект TextFragment. |
| getTextState() | Получает или задает состояние текста для текста, который представляет объект TextFragment. |
| getVerticalAlignment() | Получает вертикальное выравнивание текстового фрагмента. |
| getWrapLinesCount() | Получает количество строк переноса для этого абзаца (только для создания PDF) |
| getZIndex() | Получает значение int, указывающее Z-порядок графика. |
| hashCode() | |
| isFirstParagraphInColumn() | Получает или задает логическое значение, указывающее, будет ли этот абзац находиться в следующем столбце. |
| isInLineParagraph() | Получает абзац встроенным. |
| isInNewPage() | Получает логическое значение, которое принудительно генерирует этот абзац на новой странице. |
| isKeptWithNext() | Получает логическое значение, указывающее, остается ли текущий абзац на той же странице, что и следующий абзац. |
| isolateTextSegments(int startIndex, int length) | Получает TextSegment (s), представляющие указанную часть текста TextFragment. |
| notify() | |
| notifyAll() | |
| setBaselinePosition(Position value) | Устанавливает текстовую позицию для текста, представленного объектом TextFragment. |
| setEndNote(Note value) | Устанавливает примечание конца абзаца. |
| setFirstParagraphInColumn(boolean value) | Получает или задает логическое значение, указывающее, будет ли этот абзац находиться в следующем столбце. |
| setFootNote(Note value) | Устанавливает сноску абзаца. |
| setHorizontalAlignment(int value) | Устанавливает горизонтальное выравнивание текстового фрагмента. |
| setHyperlink(Hyperlink value) | Устанавливает гиперссылку фрагмента |
| setInLineParagraph(boolean value) | Устанавливает абзац встроенным. |
| setInNewPage(boolean value) | Устанавливает логическое значение, которое принудительно генерирует этот абзац на новой странице. |
| setKeptWithNext(boolean value) | Задает логическое значение, указывающее, остается ли текущий абзац на той же странице вместе со следующим абзацем. |
| setMargin(MarginInfo value) | Устанавливает внешнее поле для абзаца (для создания pdf) |
| setMarkedContentProperties(String name, int id) | |
| setPosition(Position value) | Устанавливает текстовую позицию для текста, представленного объектом TextFragment. |
| setRectangle(Rectangle value) | Получает прямоугольник TextFragment |
| setSegments(TextSegmentCollection value) | Представлять метод setSegments |
| setText(String value) | Задает строковый текстовый объект, который представляет объект TextFragment. |
| setVerticalAlignment(int value) | Устанавливает вертикальное выравнивание текстового фрагмента. |
| setWrapLinesCount(int value) | Устанавливает количество строк переноса для этого абзаца (только для создания pdf) |
| setZIndex(int value) | Задает значение int, указывающее Z-порядок графика. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
TextFragment()
public TextFragment()
Инициализирует новый экземпляр объекта TextFragment.
TextFragment(TabStops tabStops)
public TextFragment(TabStops tabStops)
Инициализирует новый экземпляр объекта TextFragment с предопределенными позициями TabStops.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| tabStops | TabStops | Позиции в таблице |
TextFragment(String text)
public TextFragment(String text)
Создает объект TextFragment с одним объектом TextSegment внутри. Задает текстовую строку внутри сегмента.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| text | java.lang.String | Текст фрагмента текста. |
TextFragment(String text, TabStops tabStops)
public TextFragment(String text, TabStops tabStops)
Создает объект TextFragment с одним объектом TextSegment внутри и предопределенными позициями TabStops.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| text | java.lang.String | Текст фрагмента текста. |
| tabStops | TabStops | Позиции в таблице |
cloneWithSegments()
public Object cloneWithSegments()
Клонируйте фрагмент со всеми сегментами.
Возвращает: java.lang.Object — клонированный объект
deepClone()
public Object deepClone()
Клонируйте фрагмент.
Возвращает: java.lang.Object — клонированный объект
equals(Object arg0)
public boolean equals(Object arg0)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| arg0 | java.lang.Object |
Возвращает: логический
getBaselinePosition()
public Position getBaselinePosition()
Получает текстовую позицию для текста, представленного объектом TextFragment. YIndent структуры Position представляет базовую координату текстового фрагмента.
Возвращает: Position - Значение позиции
getClass()
public final native Class<?> getClass()
Возвращает: java.lang.Класс
getEndNote()
public Note getEndNote()
Получает примечание в конце абзаца (только для создания PDF-файла).
Возвращает: Note - Примечание значение
getFootNote()
public Note getFootNote()
Получает примечание к абзацу (только для создания PDF-файла).
Возвращает: Note - Примечание значение
getForm()
public XForm getForm()
Получает объект формы, содержащий TextFragment Значение может быть нулевым, если объект TextFragment не принадлежит форме.
Возвращает: XForm - Значение X-формы
getHorizontalAlignment()
public int getHorizontalAlignment()
Получает горизонтальное выравнивание текстового фрагмента.
Возвращает: int - значение HorizontalAlignment
getHyperlink()
public Hyperlink getHyperlink()
Получает гиперссылку фрагмента (для генератора pdf).
Возвращает: Hyperlink - гиперссылка на фрагмент (для генератора pdf).
getMargin()
public MarginInfo getMargin()
Получает внешнее поле для абзаца (для создания pdf)
Возвращает: MarginInfo - значение MarginInfo
getPage()
public Page getPage()
Получает страницу, содержащую TextFragment Значение может быть нулевым, если объект TextFragment не принадлежит ни одной странице.
Возвращает: Page - Объект страницы
getPosition()
public Position getPosition()
Получает текстовую позицию для текста, представленного объектом TextFragment.
Возвращает: Position - Значение позиции
The example demonstrates how to view placement of a text, represented by ```
TextFragment
``` object.
// Открыть документ
Document doc = new Document("D:\\Tests\\input.pdf");
// Создайте объект TextFragmentAbsorber, чтобы найти все вхождения текста «hello world».
TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world");
// Принять поглотитель для первой страницы
doc.getPages().get(1).accept(absorber);
// Просмотр текста и информации о размещении первого вхождения текста
TextFragment firstOccurrence = absorber.getTextFragments().get_Item(1);
System.out.println("fragment text: " + firstOccurrence.getText()));
System.out.println("fragment X indent: "+ firstOccurrence.getPosition().getXIndent()));
System.out.println("fragment Y indent: "+ firstOccurrence.getPosition().getYIndent()));
getRectangle()
public Rectangle getRectangle()
Получает прямоугольник TextFragment
Возвращает: Rectangle - Прямоугольный объект
getReplaceOptions()
public final TextReplaceOptions getReplaceOptions()
Получает параметры замены текста. Опции определяют поведение при замене текста фрагмента на более короткий/длинный.
Возвращает: TextReplaceOptions - Экземпляр TextReplaceOptions
getSegments()
public TextSegmentCollection getSegments()
Получает текстовые сегменты для текущего TextFragment .
Возвращает: TextSegmentCollection - Значение TextSegmentCollection
The example demonstrates how to navigate all ```
TextSegment
``` objects inside ```
TextFragment
```.
// Открыть документ
Document doc = new Document("D:\\Tests\\input.pdf");
// Создайте объект TextFragmentAbsorber, чтобы найти все вхождения текста «hello world».
TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world");
// Принять поглотитель для первой страницы
doc.getPages().get(1).accept(absorber);
// Перемещайтесь по всем текстовым сегментам и из их текста и информации о размещении
for (TextSegment segment : (```
Iterable
```)absorber.getTextFragments().get_Item(1).getSegments())
{
System.out.println("segment text: "+ segment.getText()));
System.out.println("segment X indent: "+ segment.getPosition().getXIndent()));
System.out.println("segment Y indent: "+ segment.getPosition().getYIndent()));
}
В двух словах, объекты TextSegment являются дочерними элементами объекта TextFragment. Опытные пользователи могут напрямую обращаться к сегментам для выполнения более сложных сценариев редактирования текста. Подробности смотрите в описании объекта TextFragment.
getText()
public String getText()
Получает строковый текстовый объект, который представляет объект TextFragment.
Возвращает: java.lang.String — строковое значение
The example demonstrates how to search a text and replace first occurrence represented with ```
TextFragment
``` object .
// Открыть документ
Document doc = new Document("D:\\Tests\\input.pdf");
// Создайте объект TextFragmentAbsorber, чтобы найти все вхождения текста «hello world».
TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world");
// Принять поглотитель для первой страницы
doc.getPages().get(1).accept(absorber);
// Изменить шрифт первого вхождения текста
absorber.getTextFragments().get_Item(1).setText ( "hi world");
// Сохранить документ
doc.save("D:\\Tests\\output.pdf");
getTextState()
public TextFragmentState getTextState()
Получает или задает состояние текста для текста, который представляет объект TextFragment.
Возвращает: TextFragmentState - Объект TextFragmentState
The example demonstrates how to change text color and font size of the text with ```
TextState
``` object.
// Открыть документ
Document doc = new Document("D:\\Tests\\input.pdf");
// Создайте объект TextFragmentAbsorber, чтобы найти все вхождения текста «hello world».
TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world");
// Принять поглотитель для первой страницы
doc.getPages().get(1).accept(absorber);
// Изменить цвет переднего плана первого вхождения текста
absorber.getTextFragments().get_Item(1).getTextState().setForegroundColor(Color.RED);
// Изменить размер шрифта первого вхождения текста
absorber.getTextFragments().get_Item(1).getTextState().setFontSize ( 15);
// Сохранить документ
doc.save("D:\\Tests\\output.pdf");
Предоставляет возможность изменить следующие свойства текста: Font FontSize FontStyle ForegroundColor BackgroundColor
getVerticalAlignment()
public int getVerticalAlignment()
Получает вертикальное выравнивание текстового фрагмента.
Возвращает: интервал - целочисленное значение
getWrapLinesCount()
public int getWrapLinesCount()
Получает количество строк переноса для этого абзаца (только для создания PDF)
Возвращает: интервал - целочисленное значение
getZIndex()
public int getZIndex()
Получает значение int, указывающее Z-порядок графика. График с большим ZIndex будет размещен над графиком с меньшим ZIndex. ZIndex может быть отрицательным. График с отрицательным ZIndex будет размещен за текстом на странице.
Возвращает: интервал - целочисленное значение
hashCode()
public native int hashCode()
Возвращает: инт
isFirstParagraphInColumn()
public boolean isFirstParagraphInColumn()
Получает или задает логическое значение, указывающее, будет ли этот абзац находиться в следующем столбце. Значение по умолчанию — false. (для генерации pdf)
Возвращает: boolean - логическое значение
isInLineParagraph()
public boolean isInLineParagraph()
Получает абзац встроенным. Значение по умолчанию — false. (для генерации pdf)
Возвращает: boolean - логическое значение
isInNewPage()
public boolean isInNewPage()
Получает логическое значение, которое принудительно генерирует этот абзац на новой странице. Значение по умолчанию — false. (для генерации pdf)
Возвращает: boolean - логическое значение
isKeptWithNext()
public boolean isKeptWithNext()
Получает логическое значение, указывающее, остается ли текущий абзац на той же странице, что и следующий абзац. Значение по умолчанию — false. (для генерации pdf)
Возвращает: boolean - логическое значение
isolateTextSegments(int startIndex, int length)
public TextSegmentCollection isolateTextSegments(int startIndex, int length)
Получает TextSegment (s), представляющие указанную часть текста TextFragment.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| startIndex | int | Позиция в тексте, с которой будут начинаться новые TextSegment(s). |
| length | int | Длина текста, который будет изолирован в TextSegment (s). |
Возвращает: TextSegmentCollection - TextSegmentCollection, содержащая текстовые сегменты, представляющие текстовую подстроку, начинающуюся с указанной позиции и имеющую указанную длину.
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setBaselinePosition(Position value)
public void setBaselinePosition(Position value)
Устанавливает текстовую позицию для текста, представленного объектом TextFragment. YIndent структуры Position представляет базовую координату текстового фрагмента.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | Position | Значение позиции |
setEndNote(Note value)
public void setEndNote(Note value)
Устанавливает примечание в конце абзаца (только для создания PDF-файлов).
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | Note | Примечание значение |
setFirstParagraphInColumn(boolean value)
public void setFirstParagraphInColumn(boolean value)
Получает или задает логическое значение, указывающее, будет ли этот абзац находиться в следующем столбце. Значение по умолчанию — false. (для генерации pdf)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | boolean | логическое значение |
setFootNote(Note value)
public void setFootNote(Note value)
Устанавливает сноску к абзацу (только для создания PDF-файлов).
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | Note | Примечание значение |
setHorizontalAlignment(int value)
public void setHorizontalAlignment(int value)
Устанавливает горизонтальное выравнивание текстового фрагмента.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | int | Значение HorizontalAlignment |
setHyperlink(Hyperlink value)
public void setHyperlink(Hyperlink value)
Устанавливает гиперссылку фрагмента
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | Hyperlink |
setInLineParagraph(boolean value)
public void setInLineParagraph(boolean value)
Устанавливает абзац встроенным. Значение по умолчанию — false. (для генерации pdf)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | boolean | логическое значение |
setInNewPage(boolean value)
public void setInNewPage(boolean value)
Устанавливает логическое значение, которое принудительно генерирует этот абзац на новой странице. Значение по умолчанию — false. (для генерации pdf)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | boolean | логическое значение |
setKeptWithNext(boolean value)
public final void setKeptWithNext(boolean value)
Задает логическое значение, указывающее, остается ли текущий абзац на той же странице вместе со следующим абзацем. Значение по умолчанию — false. (для генерации pdf)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | boolean | логическое значение |
setMargin(MarginInfo value)
public void setMargin(MarginInfo value)
Устанавливает внешнее поле для абзаца (для создания pdf)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | MarginInfo | Объект MarginInfo |
setMarkedContentProperties(String name, int id)
public void setMarkedContentProperties(String name, int id)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| name | java.lang.String | |
| id | int |
setPosition(Position value)
public void setPosition(Position value)
Устанавливает текстовую позицию для текста, представленного объектом TextFragment.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | Position | Значение позиции |
The example demonstrates how to view placement of a text, represented by ```
TextFragment
object.
// Open document
Document doc = new Document("D:\\Tests\\input.pdf");
// Create TextFragmentAbsorber object to find all "hello world" text occurrences
TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world");
// Accept the absorber for first page
doc.getPages().get(1).accept(absorber);
// View text and placement info of first text occurrence
TextFragment firstOccurrence = absorber.getTextFragments().get_Item(1);
System.out.println("fragment text: " + firstOccurrence.getText()));
System.out.println("fragment X indent: "+ firstOccurrence.getPosition().getXIndent()));
System.out.println("fragment Y indent: "+ firstOccurrence.getPosition().getYIndent()));
### setRectangle(Rectangle value) {#setRectangle-com.aspose.pdf.Rectangle-}
public void setRectangle (значение прямоугольника)
Gets rectangle of the TextFragment
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [Rectangle](../../com.aspose.pdf/rectangle) | Rectangle instance |
### setSegments(TextSegmentCollection value) {#setSegments-com.aspose.pdf.TextSegmentCollection-}
public void setSegments (значение TextSegmentCollection)
Represent setSegments method
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [TextSegmentCollection](../../com.aspose.pdf/textsegmentcollection) | TextSegmentCollection value |
### setText(String value) {#setText-java.lang.String-}
public void setText (строковое значение)
Sets string text object that the TextFragment object represents.
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | String value
--------------------
В примере показано, как искать текст и заменять первое вхождение, представленное с помощью ``` Фрагмент текста
// Открыть документ
Document doc = new Document("D:\\Tests\\input.pdf");
// Создайте объект TextFragmentAbsorber, чтобы найти все вхождения текста «hello world».
TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world");
// Принять поглотитель для первой страницы
doc.getPages().get(1).accept(absorber);
// Изменить шрифт первого вхождения текста
absorber.getTextFragments().get_Item(1).setText ( "hi world");
// Сохранить документ
doc.save("D:\\Tests\\output.pdf");
``` |
### setVerticalAlignment(int value) {#setVerticalAlignment-int-}
public void setVerticalAlignment (целое значение)
Sets a vertical alignment of text fragment.
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | int value |
### setWrapLinesCount(int value) {#setWrapLinesCount-int-}
public void setWrapLinesCount (целое значение)
Sets wrap lines count for this paragraph(for pdf generation only)
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | int value |
### setZIndex(int value) {#setZIndex-int-}
public void setZIndex (значение int)
Sets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page.
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | int value |
### toString() {#toString--}
публичная строка toString()
**Returns:**
java.lang.String
### wait() {#wait--}
публичный окончательный недействительный ожидание ()
### wait(long arg0) {#wait-long-}
public final native void wait(long arg0)
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| arg0 | long | |
### wait(long arg0, int arg1) {#wait-long-int-}
public final void wait(long arg0, int arg1)
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| arg0 | long | |
| arg1 | int | |
