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 对象不属于表单,则该值可以为 null。
getHorizontalAlignment()获取文本片段的水平对齐方式。
getHyperlink()获取片段超链接(用于 pdf 生成器)。
getLevel()获得水平。
getMargin()获取段落的外边距(用于生成 pdf)
getPage()获取包含 TextFragment 的页面
如果 TextFragment 对象不属于任何页面,则该值可以为 null。
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()获取或设置一个 bool 值,该值指示该段落是否位于下一列。
isInLineParagraph()获取一个段落是内联的。
isInList()获取标题应该在 toc 列表中。
isInNewPage()获取强制此段落在新页面生成的 bool 值。
isKeptWithNext()获取一个布尔值,该值指示当前段落是否与下一段保持在同一页面中。
isolateTextSegments(int startIndex, int length)获取表示 TextFragment 文本指定部分的 TextSegment。
notify()
notifyAll()
setAutoSequence(boolean value)设置标题应自动编号。
setBaselinePosition(Position value)设置文本的文本位置,用 TextFragment 对象表示。
setDestinationPage(Page value)设置目标页面。
setEndNote(Note value)设置段落尾注。
setFirstParagraphInColumn(boolean value)获取或设置一个 bool 值,该值指示该段落是否位于下一列。
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)设置一个指示图形 Z 顺序的 int 值。
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

Heading()

public Heading()

仅供内部使用

Heading(int level)

public Heading(int level)

初始化 Cell 类的新实例。

参数:

范围类型描述
levelint标题级别。

cloneWithSegments()

public Object cloneWithSegments()

克隆包含所有段的标题。

退货: java.lang.Object - 克隆的对象

deepClone()

public Object deepClone()

克隆标题。

退货: java.lang.Object - 克隆的对象

equals(Object arg0)

public boolean equals(Object arg0)

参数:

范围类型描述
arg0java.lang.Object

退货: 布尔值

getBaselinePosition()

public Position getBaselinePosition()

获取文本的文本位置,用 TextFragment 对象表示。 Position 结构的 YIndent 表示文本片段的基线坐标。

退货: Position - 位置值

getClass()

public final native Class<?> getClass()

退货: java.lang.Class

getDestinationPage()

public Page getDestinationPage()

获取目标页面。

退货: Page - 目标页面。

getEndNote()

public Note getEndNote()

获取段落尾注。(仅用于 pdf 生成)

退货: Note - 注意值

getFootNote()

public Note getFootNote()

获取段落脚注。(仅用于生成 pdf)

退货: Note - 注意值

getForm()

public XForm getForm()

获取包含 TextFragment 的表单对象 如果 TextFragment 对象不属于表单,则该值可以为 null。

退货: XForm - 变形值

getHorizontalAlignment()

public int getHorizontalAlignment()

获取文本片段的水平对齐方式。

退货: int - HorizontalAlignment 值

public Hyperlink getHyperlink()

获取片段超链接(用于 pdf 生成器)。

退货: Hyperlink - 片段超链接(用于 pdf 生成器)。

getLevel()

public int getLevel()

获得水平。

退货: int - 标题级别。

getMargin()

public MarginInfo getMargin()

获取段落的外边距(用于生成 pdf)

退货: MarginInfo - 保证金信息值

getPage()

public Page getPage()

获取包含 TextFragment 的页面 如果 TextFragment 对象不属于任何页面,则该值可以为 null。

退货: 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 - 值:startNumber。

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()

获取文本片段的垂直对齐方式。

退货: int - 整数值

getWrapLinesCount()

public int getWrapLinesCount()

获取本段的换行数(仅用于生成 pdf)

退货: int - 整数值

getZIndex()

public int getZIndex()

获取一个 int 值,该值指示图形的 Z 顺序。具有较大 ZIndex 的图形将被放置在具有较小 ZIndex 的图形之上。 ZIndex 可以是负数。具有负 ZIndex 的图形将放置在页面中文本的后面。

退货: int - 整数值

hashCode()

public native int hashCode()

退货: 整数

isAutoSequence()

public boolean isAutoSequence()

获取标题应自动编号。

退货: 布尔值 - IsAutoSequens。

isFirstParagraphInColumn()

public boolean isFirstParagraphInColumn()

获取或设置一个 bool 值,该值指示该段落是否位于下一列。默认为 false。(用于生成 pdf)

退货: boolean - 布尔值

isInLineParagraph()

public boolean isInLineParagraph()

获取一个段落是内联的。默认为 false。(用于生成 pdf)

退货: boolean - 布尔值

isInList()

public boolean isInList()

获取标题应该在 toc 列表中。

退货: 布尔值 - IsInList。

isInNewPage()

public boolean isInNewPage()

获取强制此段落在新页面生成的 bool 值。默认为 false。(用于生成 pdf)

退货: boolean - 布尔值

isKeptWithNext()

public boolean isKeptWithNext()

获取一个布尔值,该值指示当前段落是否与下一段保持在同一页面中。默认为 false。(用于生成 pdf)

退货: boolean - 布尔值

isolateTextSegments(int startIndex, int length)

public TextSegmentCollection isolateTextSegments(int startIndex, int length)

获取表示 TextFragment 文本指定部分的 TextSegment。

参数:

范围类型描述
startIndexint文本中新 TextSegment 开始的位置。
lengthint将被隔离到 TextSegment (s) 中的文本的长度。

退货: TextSegmentCollection - 包含文本段的 TextSegmentCollection,表示从指定位置开始并具有指定长度的文本子字符串。

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAutoSequence(boolean value)

public void setAutoSequence(boolean value)

设置标题应自动编号。

参数:

范围类型描述
valuebooleanIsAutoSequens。

setBaselinePosition(Position value)

public void setBaselinePosition(Position value)

设置文本的文本位置,用 TextFragment 对象表示。 Position 结构的 YIndent 表示文本片段的基线坐标。

参数:

范围类型描述
valuePosition位置值

setDestinationPage(Page value)

public void setDestinationPage(Page value)

设置目标页面。

参数:

范围类型描述
valuePage目标页面。

setEndNote(Note value)

public void setEndNote(Note value)

设置段落尾注。(仅用于 pdf 生成)

参数:

范围类型描述
valueNote备注值

setFirstParagraphInColumn(boolean value)

public void setFirstParagraphInColumn(boolean value)

获取或设置一个 bool 值,该值指示该段落是否位于下一列。默认为 false。(用于生成 pdf)

参数:

范围类型描述
valueboolean布尔值

setFootNote(Note value)

public void setFootNote(Note value)

设置段落脚注。(仅用于生成 pdf)

参数:

范围类型描述
valueNote备注值

setHorizontalAlignment(int value)

public void setHorizontalAlignment(int value)

设置文本片段的水平对齐方式。

参数:

范围类型描述
valueintHorizontalAlignment 值
public void setHyperlink(Hyperlink value)

设置片段超链接

参数:

范围类型描述
valueHyperlink

setInLineParagraph(boolean value)

public void setInLineParagraph(boolean value)

设置一个段落是内联的。默认为 false。(用于生成 pdf)

参数:

范围类型描述
valueboolean布尔值

setInList(boolean value)

public void setInList(boolean value)

设置标题应该在 toc 列表中。

参数:

范围类型描述
valuebooleanIsInList。

setInNewPage(boolean value)

public void setInNewPage(boolean value)

设置一个布尔值,强制此段落在新页面生成。默认为 false。(用于生成 pdf)

参数:

范围类型描述
valueboolean布尔值

setKeptWithNext(boolean value)

public final void setKeptWithNext(boolean value)

设置一个布尔值,指示当前段落是否与下一段保持在同一页面中。默认为 false。(用于生成 pdf)

参数:

范围类型描述
valueboolean布尔值

setLevel(int value)

public void setLevel(int value)

设置电平。

参数:

范围类型描述
valueint标题级别。

setMargin(MarginInfo value)

public void setMargin(MarginInfo value)

设置段落的外边距(用于生成 pdf)

参数:

范围类型描述
valueMarginInfoMarginInfo 对象

setMarkedContentProperties(String name, int id)

public void setMarkedContentProperties(String name, int id)

参数:

范围类型描述
namejava.lang.String
idint

setPosition(Position value)

public void setPosition(Position value)

设置文本的文本位置,用 TextFragment 对象表示。

参数:

范围类型描述
valuePosition位置值

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(int 值)



Sets a vertical alignment of text fragment.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | int value |

### setWrapLinesCount(int value) {#setWrapLinesCount-int-}

public void setWrapLinesCount(int 值)



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-}

公共最终无效等待(长 arg0,int arg1)





**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| arg0 | long |  |
| arg1 | int |  |