com.aspose.words
Class LayoutCollector

java.lang.Object
    com.aspose.words.LayoutCollector

public class LayoutCollector 
extends java.lang.Object

LayoutCollector

public LayoutCollector(Document doc)

Initializes an instance of this class.

Parameters:

doc - The document to which this collector instance will be attached to.

public Document getDocument() / public void setDocument(Document value)

Gets or sets the document this collector instance is attached to.

If you need to access page indexes of the document nodes you need to set this property to point to a document instance, before page layout of the document is built. It is best to set this property to null afterwards, otherwise the collector continues to accumulate information from subsequent rebuilds of the document's page layout.

public void clear()

Clears all collected layout data. Call this method after document was manually updated, or layout was rebuilt.

public int getEndPageIndex(Node node)
                   throws java.lang.Exception

Gets 1-based index of the page where node ends. Returns 0 if node cannot be mapped to a page.

public java.lang.Object getEntity(Node node)
                throws java.lang.Exception

Returns an opaque position of the LayoutEnumerator which corresponds to the specified node. You can use returned value as an argument to LayoutEnumerator.Current given the document being enumerated and the document of the node are the same.

This method works for only Paragraph nodes, as well as indivisible inline nodes, e.g. BookmarkStart or Shape. It doesn't work for Run, CellRow or Table nodes, and nodes within header/footer.

Note that the entity returned for a Paragraph node is a paragraph break span. Use the appropriate method to ascend to the parent line

If you need to navigate to a Run of text then you can insert bookmark right before it and then navigate to the bookmark instead.

If you need to navigate to a Cell node then you can move to a Paragraph node in this cell and then ascend to a parent entity. The same approach can be used for Row and Table nodes.

public int getNumPagesSpanned(Node node)
                      throws java.lang.Exception

Gets number of pages the specified node spans. 0 if node is within a single page. This is the same as getEndPageIndex(com.aspose.words.Node) - getStartPageIndex(com.aspose.words.Node).

public int getStartPageIndex(Node node)
                     throws java.lang.Exception

Gets 1-based index of the page where node begins. Returns 0 if node cannot be mapped to a page.