com.aspose.words

Constructor Detail

• LayoutEnumerator

  public LayoutEnumerator(Document document)
                   throws java.lang.Exception

  Initializes new instance of this class.

  If page layout model of the document hasn't been built the enumerator calls Document.updatePageLayout() to build it.

  Whenever document is updated and new page layout model is created, a new enumerator must be used to access it.

  Parameters:

  document - A document whose page layout model to enumerate.

Property Getters/Setters Detail

• getCurrent/setCurrent

  public java.lang.Object getCurrent() / public void setCurrent(java.lang.Object value)
  

  Gets or sets current position in the page layout model. This property returns an opaque object which corresponds to the current layout entity.

• getDocument

  public Document getDocument()
  

  Gets document this instance enumerates.

• getKind

  public java.lang.String getKind()
  

  Gets the kind of the current entity. This can be an empty string but never null.

  This is a more specific type of the current entity, e.g. bookmark span has LayoutEntityType.SPAN type and may have either a BOOKMARKSTART or BOOKMARKEND kind.

• getPageIndex

  public int getPageIndex()
  

  Gets the 1-based index of a page which contains the current entity.

• getRectangle

  public java.awt.geom.Rectangle2D.Float getRectangle()
  

  Returns the bounding rectangle of the current entity relative to the page top left corner (in points).

• getText

  public java.lang.String getText()
  

  Gets text of the current span entity. Throws for other entity types.

• getType

  public int getType()
  

  Gets the type of the current entity. The value of the property is LayoutEntityType integer constant.

Method Detail

• moveFirstChild

  public boolean moveFirstChild()
                        throws java.lang.Exception

  Moves to the first child entity.

• moveLastChild

  public boolean moveLastChild()

  Moves to the last child entity.

• moveNext

  public boolean moveNext()
                  throws java.lang.Exception

  Moves to the next sibling entity in visual order. When iterating lines of a paragraph broken across pages this method will not move to the next page but rather move to the next entity on the same page.

• moveNextLogical

  public boolean moveNextLogical()

  Moves to the next sibling entity in a logical order. When iterating lines of a paragraph broken across pages this method will move to the next line even if it resides on another page.

  Note that all LayoutEntityType.SPAN entities are linked together thus if Current entity is span repeated calling of this method will iterates complete story of the document.

• moveParent

  public boolean moveParent()

  Moves to the parent entity.

• moveParent

  public boolean moveParent(int types)

  Moves to the parent entity of the specified type.

  This method is useful if you need to find the cell, column or header/footer parent of the entity.

  Parameters:

  types - A LayoutEntityType value. The parent entity type to move to. Use bitwise-OR to specify multiple parent types.

• movePrevious

  public boolean movePrevious()
                      throws java.lang.Exception

  Moves to the previous sibling entity.

• movePreviousLogical

  public boolean movePreviousLogical()

  Moves to the previous sibling entity in a logical order. When iterating lines of a paragraph broken across pages this method will move to the previous line even if it resides on another page.

  Note that all LayoutEntityType.SPAN entities are linked together thus if Current entity is span repeated calling of this method will iterates complete story of the document.

• reset

  public void reset()
            throws java.lang.Exception

  Moves the enumerator to the first page of the document.