com.levigo.jadice.document
Class AbstractPageEvent

java.lang.Object
  com.levigo.jadice.document.AbstractDocumentEvent
      com.levigo.jadice.document.AbstractPageEvent

Direct Known Subclasses:

PageSegmentEvent

public abstract class AbstractPageEvent
extends AbstractDocumentEvent

This is an abstract base class for page concerning document events or simply page events.

Since:

4.3

Constructor Summary

AbstractPageEvent(Document doc, Page page)
Constructor

AbstractPageEvent(Page page)
Constructor

Method Summary

Document	getDocument() Returns the document which holds the page source of this event.
Page	getPage() Return the page which originates this event
protected void	setPage(Page page) Sets the page source of this event.

Methods inherited from class com.levigo.jadice.document.AbstractDocumentEvent

setDocument

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPageEvent

public AbstractPageEvent(Page page)

Constructor

Using this constructor allows to create a page event without a reference to the enclosing document. This might be useful if the document is unknown or not available at the moment of event creation.

Parameters:

page - the page which originates this event

AbstractPageEvent

public AbstractPageEvent(Document doc,
                         Page page)

Constructor

Creates a page event with given document and page as event sources.

Parameters:

doc - the document container in which the event occurs

page - the page which originates the event

Method Detail

getPage

public Page getPage()

Return the page which originates this event

Returns:

page the source of this event

setPage

protected void setPage(Page page)

Sets the page source of this event.

Parameters:

page - the source this event is triggered by

getDocument

public Document getDocument()

Returns the document which holds the page source of this event. The return value might be null, if the document reference was unknown or not available at creation time of this event.

Overrides:

getDocument in class AbstractDocumentEvent

Returns:

the document which contains the page source of this event or null

See Also:

AbstractDocumentEvent.getDocument()