com.livescribe.event
Class PaperEvent

java.lang.Object
  com.livescribe.event.Event
      com.livescribe.event.PenletEvent
          com.livescribe.event.PaperEvent

Direct Known Subclasses:

DocumentEvent, PenTipEvent, RegionEvent, StrokeEvent

public class PaperEvent
extends PenletEvent

Provides support for all paper-related events. These include:

1. Pen tip events,
2. Stroke events,
3. Region enter and exit events, and
4. Paper, or document, events (i.e. new page and new document events).

It's worth a note here to describe why all of these events are classified as "paper" events. The pen does not register anything unless it is used on a dot pattern printed on some medium, for example stickers, notebooks, laminated pages, surfaces, etc. This means that no events occur unless dot paper is used.

In other words, it is the paper that causes the pen's use to mean anything. In retrospect, a better name might have been, "Dot Paper" or "Dot Pattern" event.

See Also:

PenTipListener, RegionEnterExitListener, StrokeListener, PaperListener

Field Summary

Region	areaId The region object.
PageInstance	pageInstance The page object.
static int	PE_AREAENTER The area enter event.
static int	PE_AREAEXIT The area exit event.
static int	PE_COORDINATE
static int	PE_NEWDOCUMENT The new document event.
static int	PE_NEWPAGE The new page event.
static int	PE_PENDOWN The pen down event.
static int	PE_PENUP The pen up event.
static int	PE_STROKE The stroke event.

Fields inherited from class com.livescribe.event.PenletEvent

size, time

Fields inherited from class com.livescribe.event.Event

consumed, eventId

Method Summary

int	getCopy() Gets the page instance's copy number.
int	getPage() Gets the page's page number.
PageInstance	getPageInstance() Gets the page object.
Region	getRegion() Gets the region object.
protected String	toDate() Returns the empty string.
String	toString() Returns a string representation of this event.

Methods inherited from class com.livescribe.event.PenletEvent

getTime

Methods inherited from class com.livescribe.event.Event

consume, getId, isConsumed

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PE_AREAENTER

public static final int PE_AREAENTER

The area enter event.

See Also:

Constant Field Values

PE_AREAEXIT

public static final int PE_AREAEXIT

The area exit event.

See Also:

Constant Field Values

PE_STROKE

public static final int PE_STROKE

The stroke event.

See Also:

Constant Field Values

PE_COORDINATE

public static final int PE_COORDINATE

See Also:

Constant Field Values

PE_PENDOWN

public static final int PE_PENDOWN

The pen down event.

See Also:

Constant Field Values

PE_PENUP

public static final int PE_PENUP

The pen up event.

See Also:

Constant Field Values

PE_NEWPAGE

public static final int PE_NEWPAGE

The new page event.

See Also:

Constant Field Values

PE_NEWDOCUMENT

public static final int PE_NEWDOCUMENT

The new document event.

See Also:

Constant Field Values

pageInstance

public final PageInstance pageInstance

The page object.

areaId

public final Region areaId

The region object.

Method Detail

getPageInstance

public PageInstance getPageInstance()

Gets the page object.

Returns:

the page object.

getRegion

public Region getRegion()

Gets the region object.

Returns:

the region object.

toString

public String toString()

Returns a string representation of this event.

Overrides:

toString in class PenletEvent

Returns:

a string representation of this event.

getCopy

public int getCopy()

Gets the page instance's copy number.

Returns:

the page's copy number.

See Also:

PageInstance.getCopy()

getPage

public int getPage()

Gets the page's page number.

Returns:

the page's page number.

See Also:

PageInstance.getPage()

toDate

protected final String toDate()

Returns the empty string.

Overrides:

toDate in class PenletEvent

Returns:

the empty string.