org.icepdf.core.events

Class PageImageEvent

java.lang.Object

java.util.EventObject

org.icepdf.core.events.PageInitializingEvent

org.icepdf.core.events.PageImageEvent

All Implemented Interfaces:

java.io.Serializable

public class PageImageEvent
extends PageInitializingEvent

PageImageEvent is fired when an image is done loading. The event stores the image number that was loaded and the total number of images. The total image is as specified by the parent page's resource dictionary and may not 100% reliable. It should also be noted that the total count also excludes inline images as the total inline images is only know after parsing is complete.

Since:

5.1.0

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
PageImageEvent(Page pageSource, int index, int total, long duration, boolean interrupted) Construct a new PageImageEvent

Method Summary

Modifier and Type	Method and Description
long	getDuration()
int	getIndex() The image index with respect to the total number of images.
int	getTotal() The total number of images being loaded for the parent page.

Methods inherited from class org.icepdf.core.events.PageInitializingEvent

isInterrupted

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PageImageEvent

public PageImageEvent(Page pageSource,
                      int index,
                      int total,
                      long duration,
                      boolean interrupted)

Construct a new PageImageEvent

Parameters:

pageSource - parent page.

index - index of image in the resource dictionary

total - total number of images to loaded.

interrupted - true if the image loading was interrupted in anyway.

Method Detail

getIndex

public int getIndex()

The image index with respect to the total number of images.

Returns:

image index.

getTotal

public int getTotal()

The total number of images being loaded for the parent page.

Returns:

total number of images to load.

getDuration

public long getDuration()