com.livescribe.event
Class RegionEvent

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

public class RegionEvent
extends PaperEvent

This event type provides support for region events.

Note that the PE_XXX fields are not used with this event. Use the REGION_xxx fields from this class.

Since:

2.3

See Also:

RegionEnterExitListener

Field Summary

static int	REGION_ENTERED The region entered event.
static int	REGION_EXITED The region exited event.
static int	REGION_FIRST_ID The first number in the range of ID's used for this event.
static int	REGION_LAST_ID The last number in the range of ID's used for this event.

Fields inherited from class com.livescribe.event.PaperEvent

areaId, pageInstance, PE_AREAENTER, PE_AREAEXIT, PE_COORDINATE, PE_NEWDOCUMENT, PE_NEWPAGE, PE_PENDOWN, PE_PENUP, PE_STROKE

Fields inherited from class com.livescribe.event.PenletEvent

size, time

Fields inherited from class com.livescribe.event.Event

consumed, eventId

Constructor Summary

RegionEvent(int id, long time, PageInstance page, Region region)
Creates a new stroke event using the specified parameters.

Method Summary

Methods inherited from class com.livescribe.event.PaperEvent

getCopy, getPage, getPageInstance, getRegion, toDate, toString

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

REGION_FIRST_ID

public static final int REGION_FIRST_ID

The first number in the range of ID's used for this event.

See Also:

Constant Field Values

REGION_LAST_ID

public static final int REGION_LAST_ID

The last number in the range of ID's used for this event.

See Also:

Constant Field Values

REGION_ENTERED

public static final int REGION_ENTERED

The region entered event.

See Also:

Constant Field Values

REGION_EXITED

public static final int REGION_EXITED

The region exited event.

See Also:

Constant Field Values

Constructor Detail

RegionEvent

public RegionEvent(int id,
                   long time,
                   PageInstance page,
                   Region region)

Creates a new stroke event using the specified parameters.

Parameters:

id - the event ID

time - the event time

page - the page object

region - the region object