LayoutEnumerator (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.LayoutEnumerator

```
public class LayoutEnumerator
extends java.lang.Object
```
Enumerates page layout entities of a document. You can use this class to walk over the page layout model. Available properties are type, geometry, text and page index where entity is rendered, as well as overall structure and relationships. Use combination of LayoutCollector.getEntity(com.aspose.words.Node) and getCurrent() / setCurrent(java.lang.Object) move to the entity which corresponds to a document node.
To learn more, visit the Converting to Fixed-page Format documentation article.

Constructor Summary

Constructors
Constructor and Description

LayoutEnumerator(Document document)
Initializes new instance of this class.

Constructors
Constructor and Description
`LayoutEnumerator(Document document)` Initializes new instance of this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`get(java.lang.String key)` Gets a named property of the entity.
`java.lang.Object`	`getCurrent()` Gets current position in the page layout model.
`Document`	`getDocument()` Gets document this instance enumerates.
`java.lang.String`	`getKind()` Gets the kind of the current entity.
`int`	`getPageIndex()` Gets the 1-based index of a page which contains the current entity.
`java.awt.geom.Rectangle2D.Float`	`getRectangle()` Returns the bounding rectangle of the current entity relative to the page top left corner (in points).
`java.lang.String`	`getText()` Gets text of the current span entity.
`int`	`getType()` Gets the type of the current entity.
`boolean`	`moveFirstChild()` Moves to the first child entity.
`boolean`	`moveLastChild()` Moves to the last child entity.
`boolean`	`moveNext()` Moves to the next sibling entity in visual order.
`boolean`	`moveNextLogical()` Moves to the next sibling entity in a logical order.
`boolean`	`moveParent()` Moves to the parent entity.
`boolean`	`moveParent(int types)`
`boolean`	`movePrevious()` Moves to the previous sibling entity.
`boolean`	`movePreviousLogical()` Moves to the previous sibling entity in a logical order.
`void`	`reset()` Moves the enumerator to the first page of the document.
`void`	`setCurrent(java.lang.Object value)` Sets current position in the page layout model.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LayoutEnumerator
```
public LayoutEnumerator(Document document)
                 throws java.lang.Exception
```
    Initializes new instance of this class.
    
    Parameters:
    
    document - A document whose page layout model to enumerate.
    
    Throws:
    
    java.lang.Exception
- Method Detail
  - reset
```
public void reset()
           throws java.lang.Exception
```
    Moves the enumerator to the first page of the document.
    
    Throws:
    
    java.lang.Exception
  - 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.
    
    Throws:
    
    java.lang.Exception
  - 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 getCurrent() / setCurrent(java.lang.Object) entity is span repeated calling of this method will iterates complete story of the document.
  - movePrevious
```
public boolean movePrevious()
                     throws java.lang.Exception
```
    Moves to the previous sibling entity.
    
    Throws:
    
    java.lang.Exception
  - 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 getCurrent() / setCurrent(java.lang.Object) entity is span repeated calling of this method will iterates complete story of the document.
  - moveFirstChild
```
public boolean moveFirstChild()
                       throws java.lang.Exception
```
    Moves to the first child entity.
    
    Throws:
    
    java.lang.Exception
  - moveLastChild
```
public boolean moveLastChild()
                      throws java.lang.Exception
```
    Moves to the last child entity.
    
    Throws:
    
    java.lang.Exception
  - moveParent
```
public boolean moveParent()
```
    Moves to the parent entity.
  - moveParent
```
public boolean moveParent(int types)
```
  - getType
```
public int getType()
```
    Gets the type of the current entity.
    
    Returns:
    
    The type of the current entity. The returned value is a bitwise combination of LayoutEntityType constants.
  - getRectangle
```
public java.awt.geom.Rectangle2D.Float getRectangle()
                                             throws java.lang.Exception
```
    Returns the bounding rectangle of the current entity relative to the page top left corner (in points).
    
    Returns:
    
    The bounding rectangle of the current entity relative to the page top left corner (in points).
    
    Throws:
    
    java.lang.Exception
  - getKind
```
public java.lang.String getKind()
                         throws java.lang.Exception
```
    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.
    
    Returns:
    
    The kind of the current entity.
    
    Throws:
    
    java.lang.Exception
  - getText
```
public java.lang.String getText()
                         throws java.lang.Exception
```
    Gets text of the current span entity. Throws for other entity types.
    
    Returns:
    
    Text of the current span entity.
    
    Throws:
    
    java.lang.Exception
  - getPageIndex
```
public int getPageIndex()
```
    Gets the 1-based index of a page which contains the current entity.
    
    Returns:
    
    The 1-based index of a page which contains the current entity.
  - getCurrent
```
public java.lang.Object getCurrent()
```
    Gets current position in the page layout model. This property returns an opaque object which corresponds to the current layout entity.
    
    Returns:
    
    Current position in the page layout model.
  - setCurrent
```
public void setCurrent(java.lang.Object value)
                throws java.lang.Exception
```
    Sets current position in the page layout model. This property returns an opaque object which corresponds to the current layout entity.
    
    Parameters:
    
    value - Current position in the page layout model.
    
    Throws:
    
    java.lang.Exception
  - getDocument
```
public Document getDocument()
```
    Gets document this instance enumerates.
    
    Returns:
    
    Document this instance enumerates.
  - get
```
public java.lang.Object get(java.lang.String key)
```
    Gets a named property of the entity.
    
    Parameters:
    
    key - A name of the property (case-sensitive).
    
    Returns:
    
    Null if property is not available, otherwise value of the property.

Class LayoutEnumerator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LayoutEnumerator

Method Detail

reset

moveNext

moveNextLogical

movePrevious

movePreviousLogical

moveFirstChild

moveLastChild

moveParent

moveParent

getType

getRectangle

getKind

getText

getPageIndex

getCurrent

setCurrent

getDocument

get