Heading
Наследование: java.lang.Object, com.aspose.pdf.BaseParagraph, com.aspose.pdf.TextFragment
public final class Heading extends TextFragment
Представляет заголовок.
Конструкторы
Конструктор | Описание |
---|---|
Heading() | Только для внутреннего использования |
Heading(int level) | Инициализирует новый экземпляр класса Cell. |
Методы
Метод | Описание |
---|---|
cloneWithSegments() | Клонируйте заголовок со всеми сегментами. |
deepClone() | Клонируйте заголовок. |
equals(Object arg0) | |
getBaselinePosition() | Получает текстовую позицию для текста, представленного объектом TextFragment. |
getClass() | |
getDestinationPage() | Получает целевую страницу. |
getEndNote() | Получает примечание в конце абзаца. |
getFootNote() | Получает сноску абзаца. |
getForm() | Получает объект формы, содержащий TextFragment |
Значение может быть нулевым, если объект TextFragment не принадлежит форме. | |
getHorizontalAlignment() | Получает горизонтальное выравнивание текстового фрагмента. |
getHyperlink() | Получает гиперссылку фрагмента (для генератора pdf). |
getLevel() | Получает уровень. |
getMargin() | Получает внешнее поле для абзаца (для создания pdf) |
getPage() | Получает страницу, содержащую TextFragment |
Значение может быть нулевым, если объект TextFragment не принадлежит ни одной странице. | |
getPosition() | Получает текстовую позицию для текста, представленного объектом TextFragment. |
getRectangle() | Получает прямоугольник TextFragment |
getReplaceOptions() | Получает параметры замены текста. |
getSegments() | Получает текстовые сегменты для текущего TextFragment . |
getStartNumber() | Получает начальный номер заголовка. |
getStyle() | Получает или задает стиль. |
getText() | Получает строковый текстовый объект, который представляет объект TextFragment. |
getTextState() | Получает или задает состояние текста для текста, который представляет объект TextFragment. |
getTocPage() | Получает страницу, содержащую этот заголовок. |
getTop() | Получает верхнюю Y этих заголовков (для внутреннего использования). |
getUserLabel() | Получает или задает метку пользователя. |
getVerticalAlignment() | Получает вертикальное выравнивание текстового фрагмента. |
getWrapLinesCount() | Получает количество строк переноса для этого абзаца (только для создания PDF) |
getZIndex() | Получает значение int, указывающее Z-порядок графика. |
hashCode() | |
isAutoSequence() | Получает заголовок должен нумероваться автоматически. |
isFirstParagraphInColumn() | Получает или задает логическое значение, указывающее, будет ли этот абзац находиться в следующем столбце. |
isInLineParagraph() | Получает абзац встроенным. |
isInList() | Получает, что заголовок должен быть в списке toc. |
isInNewPage() | Получает логическое значение, которое принудительно генерирует этот абзац на новой странице. |
isKeptWithNext() | Получает логическое значение, указывающее, остается ли текущий абзац на той же странице, что и следующий абзац. |
isolateTextSegments(int startIndex, int length) | Получает TextSegment (s), представляющие указанную часть текста TextFragment. |
notify() | |
notifyAll() | |
setAutoSequence(boolean value) | устанавливает, что заголовок должен быть пронумерован автоматически. |
setBaselinePosition(Position value) | Устанавливает текстовую позицию для текста, представленного объектом TextFragment. |
setDestinationPage(Page value) | устанавливает целевую страницу. |
setEndNote(Note value) | Устанавливает примечание конца абзаца. |
setFirstParagraphInColumn(boolean value) | Получает или задает логическое значение, указывающее, будет ли этот абзац находиться в следующем столбце. |
setFootNote(Note value) | Устанавливает сноску абзаца. |
setHorizontalAlignment(int value) | Устанавливает горизонтальное выравнивание текстового фрагмента. |
setHyperlink(Hyperlink value) | Устанавливает гиперссылку фрагмента |
setInLineParagraph(boolean value) | Устанавливает абзац встроенным. |
setInList(boolean value) | устанавливает, что заголовок должен быть в списке toc. |
setInNewPage(boolean value) | Устанавливает логическое значение, которое принудительно генерирует этот абзац на новой странице. |
setKeptWithNext(boolean value) | Задает логическое значение, указывающее, остается ли текущий абзац на той же странице вместе со следующим абзацем. |
setLevel(int value) | устанавливает уровень. |
setMargin(MarginInfo value) | Устанавливает внешнее поле для абзаца (для создания pdf) |
setMarkedContentProperties(String name, int id) | |
setPosition(Position value) | Устанавливает текстовую позицию для текста, представленного объектом TextFragment. |
setRectangle(Rectangle value) | Получает прямоугольник TextFragment |
setSegments(TextSegmentCollection value) | Представлять метод setSegments |
setStartNumber(int value) | Получает начальный номер заголовка. |
setStyle(int value) | устанавливает или устанавливает стиль. |
setText(String value) | Задает строковый текстовый объект, который представляет объект TextFragment. |
setTocPage(Page value) | Задает страницу, содержащую этот заголовок. |
setTop(double value) | устанавливает верхний Y этих заголовков (для внутреннего использования). |
setUserLabel(TextSegment value) | Получает или задает метку пользователя. |
setVerticalAlignment(int value) | Устанавливает вертикальное выравнивание текстового фрагмента. |
setWrapLinesCount(int value) | Устанавливает количество строк переноса для этого абзаца (только для создания pdf) |
setZIndex(int value) | Задает значение int, указывающее Z-порядок графика. |
toString() | |
wait() | |
wait(long arg0) | |
wait(long arg0, int arg1) |
Heading()
public Heading()
Только для внутреннего использования
Heading(int level)
public Heading(int level)
Инициализирует новый экземпляр класса Cell.
Параметры:
Параметр | Тип | Описание |
---|---|---|
level | int | Уровень заголовков. |
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.Класс
getDestinationPage()
public Page getDestinationPage()
Получает целевую страницу.
Возвращает: Page - Страница назначения.
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).
getLevel()
public int getLevel()
Получает уровень.
Возвращает: int - Уровень заголовка.
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.
getStartNumber()
public int getStartNumber()
Получает начальный номер заголовка.
Возвращает: int — значение: начальный номер.
getStyle()
public int getStyle()
Получает или задает стиль.
Возвращает: int - Стиль заголовка.
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
getTocPage()
public Page getTocPage()
Получает страницу, содержащую этот заголовок.
Возвращает: Page - Страница.
getTop()
public double getTop()
Получает верхнюю Y этих заголовков (для внутреннего использования).
Возвращает: double - Верхнее значение Y
getUserLabel()
public TextSegment getUserLabel()
Получает или задает метку пользователя.
Возвращает: TextSegment - Объект TextSegment
getVerticalAlignment()
public int getVerticalAlignment()
Получает вертикальное выравнивание текстового фрагмента.
Возвращает: интервал - целочисленное значение
getWrapLinesCount()
public int getWrapLinesCount()
Получает количество строк переноса для этого абзаца (только для создания PDF)
Возвращает: интервал - целочисленное значение
getZIndex()
public int getZIndex()
Получает значение int, указывающее Z-порядок графика. График с большим ZIndex будет размещен над графиком с меньшим ZIndex. ZIndex может быть отрицательным. График с отрицательным ZIndex будет размещен за текстом на странице.
Возвращает: интервал - целочисленное значение
hashCode()
public native int hashCode()
Возвращает: инт
isAutoSequence()
public boolean isAutoSequence()
Получает заголовок должен нумероваться автоматически.
Возвращает: логическое значение — IsAutoSequens.
isFirstParagraphInColumn()
public boolean isFirstParagraphInColumn()
Получает или задает логическое значение, указывающее, будет ли этот абзац находиться в следующем столбце. Значение по умолчанию — false. (для генерации pdf)
Возвращает: boolean - логическое значение
isInLineParagraph()
public boolean isInLineParagraph()
Получает абзац встроенным. Значение по умолчанию — false. (для генерации pdf)
Возвращает: boolean - логическое значение
isInList()
public boolean isInList()
Получает, что заголовок должен быть в списке toc.
Возвращает: логическое значение — IsInList.
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()
setAutoSequence(boolean value)
public void setAutoSequence(boolean value)
устанавливает, что заголовок должен быть пронумерован автоматически.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | boolean | IsAutoSequens. |
setBaselinePosition(Position value)
public void setBaselinePosition(Position value)
Устанавливает текстовую позицию для текста, представленного объектом TextFragment. YIndent структуры Position представляет базовую координату текстового фрагмента.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | Position | Значение позиции |
setDestinationPage(Page value)
public void setDestinationPage(Page value)
устанавливает целевую страницу.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | Page | Страница назначения. |
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 | логическое значение |
setInList(boolean value)
public void setInList(boolean value)
устанавливает, что заголовок должен быть в списке toc.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | boolean | IsInList. |
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 | логическое значение |
setLevel(int value)
public void setLevel(int value)
устанавливает уровень.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | int | Уровень заголовка. |
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 |
### setStartNumber(int value) {#setStartNumber-int-}
public void setStartNumber (значение int)
Gets the heading start number.
Value: The startNumber.
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The startNumber. |
### setStyle(int value) {#setStyle-int-}
public void setStyle (значение int)
sets or sets style.
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | The heading style. |
### 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");
``` |
### setTocPage(Page value) {#setTocPage-com.aspose.pdf.Page-}
public void setTocPage (значение страницы)
Sets the page that contains this heading.
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [Page](../../com.aspose.pdf/page) | The page. |
### setTop(double value) {#setTop-double-}
public void setTop (двойное значение)
sets the top Y of this headings(for internal use).
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | The top Y value |
### setUserLabel(TextSegment value) {#setUserLabel-com.aspose.pdf.TextSegment-}
public void setUserLabel (значение TextSegment)
Gets or sets user label.
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [TextSegment](../../com.aspose.pdf/textsegment) | TextSegment object |
### 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 | |