com.aspose.words

Class PageLayoutEvent

java.lang.Object

com.aspose.words.PageLayoutEvent

public final class PageLayoutEvent
extends java.lang.Object

A utility class providing constants. A code of event raised during page layout model build and rendering.

Page layout model is built in two steps. First, "conversion step", this is when page layout pulls document content and creates object graph. Second, "reflow step", this is when structures are split, merged and arranged into pages.

Depending of the operation which triggered build, page layout model may or may not be further rendered into fixed page format. For example, computing number of pages in the document or updating fields does not require rendering, whereas export to Pdf does.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUILD_FINISHED Build of the page layout has finished.
static int	BUILD_STARTED Build of the page layout has started.
static int	CONVERSION_FINISHED Conversion of document model to page layout has finished.
static int	CONVERSION_STARTED Conversion of document model to page layout has started.
static int	length
static int	NONE Default value
static int	PART_REFLOW_FINISHED Reflow of the page has finished.
static int	PART_REFLOW_STARTED Reflow of the page has started.
static int	PART_RENDERING_FINISHED Rendering of page has finished.
static int	PART_RENDERING_STARTED Rendering of page has started.
static int	REFLOW_FINISHED Reflow of the page layout has finished.
static int	REFLOW_STARTED Reflow of the page layout has started.
static int	WATCH_DOG Corresponds to a checkpoint in code which is often visited and which is suitable to abort process.

Method Summary

Modifier and Type	Method and Description
static int	fromName(java.lang.String pageLayoutEventName)
static java.lang.String	getName(int pageLayoutEvent)
static int[]	getValues()
static java.lang.String	toString(int pageLayoutEvent)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static final int NONE

Default value

WATCH_DOG

public static final int WATCH_DOG

Corresponds to a checkpoint in code which is often visited and which is suitable to abort process.

While inside IPageLayoutCallback.notify(com.aspose.words.PageLayoutCallbackArgs) throw custom exception to abort process.

You can throw when handling any callback event to abort process.

Note that if process is aborted the page layout model remains in undefined state. If process is aborted upon reflow of a complete page, however, it should be possible to use layout model up to the end of that page.

BUILD_STARTED

public static final int BUILD_STARTED

Build of the page layout has started. Fired once. This is the first event which occurs when Document.updatePageLayout() is called.

BUILD_FINISHED

public static final int BUILD_FINISHED

Build of the page layout has finished. Fired once. This is the last event which occurs when Document.updatePageLayout() is called.

CONVERSION_STARTED

public static final int CONVERSION_STARTED

Conversion of document model to page layout has started. Fired once. This occurs when layout model starts pulling document content.

CONVERSION_FINISHED

public static final int CONVERSION_FINISHED

Conversion of document model to page layout has finished. Fired once. This occurs when layout model stops pulling document content.

REFLOW_STARTED

public static final int REFLOW_STARTED

Reflow of the page layout has started. Fired once. This occurs when layout model starts reflowing document content.

REFLOW_FINISHED

public static final int REFLOW_FINISHED

Reflow of the page layout has finished. Fired once. This occurs when layout model stops reflowing document content.

PART_REFLOW_STARTED

public static final int PART_REFLOW_STARTED

Reflow of the page has started. Note that page may reflow multiple times and that reflow may restart before it is finished.

See Also:

PageLayoutCallbackArgs.getPageIndex()

PART_REFLOW_FINISHED

public static final int PART_REFLOW_FINISHED

Reflow of the page has finished. Note that page may reflow multiple times and that reflow may restart before it is finished.

See Also:

PageLayoutCallbackArgs.getPageIndex()

PART_RENDERING_STARTED

public static final int PART_RENDERING_STARTED

Rendering of page has started. This is fired once per page.

PART_RENDERING_FINISHED

public static final int PART_RENDERING_FINISHED

Rendering of page has finished. This is fired once per page.

length

public static final int length

Method Detail

getName

public static java.lang.String getName(int pageLayoutEvent)

toString

public static java.lang.String toString(int pageLayoutEvent)

fromName

public static int fromName(java.lang.String pageLayoutEventName)

getValues

public static int[] getValues()