LayoutCollector
遗产: java.lang.Object
public class LayoutCollector
此类允许计算文档节点的页码。
要了解更多信息,请访问Converting to Fixed-page Format文档文章。
当你创建一个LayoutCollector并指定一个Document要附加到的文档对象,当文档被格式化为页面时,收集器将记录文档节点到布局对象的映射。
您将能够通过使用getStartPageIndex(com.aspose.words.Node), getEndPageIndex(com.aspose.words.Node)和getNumPagesSpanned(com.aspose.words.Node)方法。如果需要,这些方法会自动构建文档的页面布局模型并更新字段。
当您不再需要收集布局信息时,最好将getDocument() / setDocument(com.aspose.words.Document)属性为 null 以避免不必要地收集更多布局映射。
构造器
构造函数 | 描述 |
---|---|
LayoutCollector(Document doc) | 初始化此类的一个实例。 |
方法
方法 | 描述 |
---|---|
clear() | 清除所有收集的布局数据。 |
equals(Object arg0) | |
getClass() | |
getDocument() | 获取此收集器实例附加到的文档。 |
getEndPageIndex(Node node) | 获取节点结束的页面的从 1 开始的索引。 |
getEntity(Node node) | 返回一个不透明的位置LayoutEnumerator对应于指定的节点。 |
getNumPagesSpanned(Node node) | 获取指定节点跨越的页数。 |
getStartPageIndex(Node node) | 获取节点开始的页面的从 1 开始的索引。 |
hashCode() | |
notify() | |
notifyAll() | |
setDocument(Document value) | 设置此收集器实例附加到的文档。 |
toString() | |
wait() | |
wait(long arg0) | |
wait(long arg0, int arg1) |
LayoutCollector(Document doc)
public LayoutCollector(Document doc)
初始化此类的一个实例。
参数:
范围 | 类型 | 描述 |
---|---|---|
doc | Document | 此收集器实例将附加到的文档。 |
clear()
public void clear()
清除所有收集的布局数据。在手动更新文档或重建布局后调用此方法。
equals(Object arg0)
public boolean equals(Object arg0)
参数:
范围 | 类型 | 描述 |
---|---|---|
arg0 | java.lang.Object |
退货: 布尔值
getClass()
public final native Class<?> getClass()
退货: java.lang.Class
getDocument()
public Document getDocument()
获取此收集器实例附加到的文档。如果您需要访问文档节点的页面索引,则需要在构建文档的页面布局之前将此属性设置为指向文档实例。最好随后将此属性设置为 null,否则收集器会继续从文档页面布局的后续重建中积累信息。
退货: Document - 此收集器实例附加到的文档。
getEndPageIndex(Node node)
public int getEndPageIndex(Node node)
获取节点结束的页面的从 1 开始的索引。如果节点无法映射到页面,则返回 0。
参数:
范围 | 类型 | 描述 |
---|---|---|
node | Node |
退货: 整数
getEntity(Node node)
public Object getEntity(Node node)
返回一个不透明的位置LayoutEnumerator对应于指定的节点。您可以使用返回值作为参数LayoutEnumerator.getCurrent() / LayoutEnumerator.setCurrent(java.lang.Object)给定被枚举的文档和节点的文档是相同的。
此方法仅适用于Paragraph节点,以及不可分割的内联节点,例如BookmarkStart或者Shape.它不适用于Run, Cell Row或者Table节点,以及页眉/页脚中的节点。
请注意,返回的实体Paragraph节点是一个段落分隔跨度。使用适当的方法提升到父行
如果您需要导航到Run文本然后您可以在它之前插入书签,然后导航到书签。
如果您需要导航到Cell节点然后你可以移动到一个Paragraph此单元格中的节点,然后上升到父实体。同样的方法可以用于Row和Table节点。
参数:
范围 | 类型 | 描述 |
---|---|---|
node | Node |
退货: java.lang.Object
getNumPagesSpanned(Node node)
public int getNumPagesSpanned(Node node)
获取指定节点跨越的页数。如果节点在单个页面内则为 0。这与getEndPageIndex(com.aspose.words.Node) -getStartPageIndex(com.aspose.words.Node).
参数:
范围 | 类型 | 描述 |
---|---|---|
node | Node |
退货: 整数
getStartPageIndex(Node node)
public int getStartPageIndex(Node node)
获取节点开始的页面的从 1 开始的索引。如果节点无法映射到页面,则返回 0。
参数:
范围 | 类型 | 描述 |
---|---|---|
node | Node |
退货: 整数
hashCode()
public native int hashCode()
退货: 整数
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setDocument(Document value)
public void setDocument(Document value)
设置此收集器实例附加到的文档。如果您需要访问文档节点的页面索引,则需要在构建文档的页面布局之前将此属性设置为指向文档实例。最好随后将此属性设置为 null,否则收集器会继续从文档页面布局的后续重建中积累信息。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | Document | 此收集器实例附加到的文档。 |
toString()
public String toString()
退货: java.lang.字符串
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
参数:
范围 | 类型 | 描述 |
---|---|---|
arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
参数:
范围 | 类型 | 描述 |
---|---|---|
arg0 | long | |
arg1 | int |