PenProfile 2.x

com.livescribe.event
Class HardwareEvent

java.lang.Object
  extended by com.livescribe.event.Event
      extended by com.livescribe.event.PenletEvent
          extended by com.livescribe.event.SystemEvent
              extended by com.livescribe.event.HardwareEvent

public class HardwareEvent
extends SystemEvent

The HardwareEvent class extends the SystemEvent class to encapsulate hardware specific events.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.livescribe.event.SystemEvent
SystemEvent.Config
 
Field Summary
static HardwareEvent AbortQuickRecord
          HardwareEvent to indicate that quick record has been stopped
static int BASE
           
static HardwareEvent BatteryDischarged
          HardwareEvent to indicate that pen battery is discharged
static HardwareEvent BatteryFull
          HardwareEvent to indicate that pen battery is full
static HardwareEvent BatteryLow
          HardwareEvent to indicate that pen battery is low
static HardwareEvent BatteryNormal
          HardwareEvent to indicate that pen battery is normal
static short HE_BATTERY_DISCHARGED
          ID to indicate that the pen battery is discharged
static short HE_BATTERY_FULL
          ID to indicate that the battery level is full
static short HE_BATTERY_LOW
          ID to indicate that the battery level is low
static short HE_BATTERY_NORMAL
          ID to indicate that the battery level is normal
static short HE_CHARGING
          ID to indicate that the pen is currently charging
static short HE_CHARGING_COMPLETE
          ID to indicate that the pen charging is complete
static short HE_MEMORY_FULL
          ID to indicate that the pen memory is full
static short HE_MEMORY_LOW
          ID to indicate that pen memory is low
static short HE_MEMORY_NORMAL
          ID to indicate that pen memory is normal
static short HE_MIC_PLUGGED_IN
          ID to indicate that the mic is plugged in
static short HE_MIC_PLUGGED_OUT
          ID to indicate that the mic is plugged out
static short HE_NOT_CHARGING
          ID to indicate that the pen is not currently charging
static short HE_PHONES_PLUGGED_IN
          ID to indicate that the headphones are plugged in
static short HE_PHONES_UNPLUGGED
          ID to indicate that the headphones are plugged out
static int HE_QUICKRECORD
          ID to indicate that quick record has started
static int HE_QUICKRECORD_ABORT
          ID to indicate that quick record has aborted
static short HE_USB_CONNECTED
          ID to indicate that the pen is connected via USB
static short HE_USB_DISCONNECTED
          ID to indicate that the pen is not connected via USB
static HardwareEvent MemoryFull
          HardwareEvent to indicate that pen memory is full
static HardwareEvent MemoryLow
          HardwareEvent to indicate that pen memory is low
static HardwareEvent MemoryNormal
          HardwareEvent to indicate that pen memory is normal
 
Fields inherited from class com.livescribe.event.SystemEvent
AutoOffSound, MuteWarningOff, MuteWarningOn, param1, param2, RecordingStarted, RecordingStopped, ScrollPausedAtEnd, ScrollPausedAtStart, SE_AUTO_OFF_SOUND, SE_DEBUG_DUMP_THREADS, SE_DOCKING_STARTED, SE_DOCKING_STOPPED, SE_DOUBLETAP, SE_DOWNLOAD_DATA_START, SE_DOWNLOAD_DATA_STOP, SE_LSP_NOT_FOUND, SE_MUTE_WARN_OFF, SE_MUTE_WARN_ON, SE_NULL, SE_OUTSIDE_PAPER_SPACE, SE_PROFILE_DUMP, SE_PROFILE_OFF, SE_PROFILE_ON, SE_PROPERTY_CHANGED, SE_RECORDING_STARTED, SE_RECORDING_STOPPED, SE_SCROLL_PAUSED_AT_END, SE_SCROLL_PAUSED_AT_START, SE_SHUTDOWN, SE_SINGLETAP, SE_TODO, SE_UPLOAD_DATA_START, SE_UPLOAD_DATA_STOP
 
Fields inherited from class com.livescribe.event.PenletEvent
size, time
 
Fields inherited from class com.livescribe.event.Event
consumed, eventId
 
Method Summary
 String toString()
          Return a String representation of the HardwareEvent
 
Methods inherited from class com.livescribe.event.PenletEvent
getTime, toDate
 
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

BASE

public static final int BASE
See Also:
Constant Field Values

HE_QUICKRECORD

public static final int HE_QUICKRECORD
ID to indicate that quick record has started

See Also:
Constant Field Values

HE_QUICKRECORD_ABORT

public static final int HE_QUICKRECORD_ABORT
ID to indicate that quick record has aborted

See Also:
Constant Field Values

HE_BATTERY_LOW

public static final short HE_BATTERY_LOW
ID to indicate that the battery level is low

See Also:
Constant Field Values

HE_BATTERY_NORMAL

public static final short HE_BATTERY_NORMAL
ID to indicate that the battery level is normal

See Also:
Constant Field Values

HE_BATTERY_FULL

public static final short HE_BATTERY_FULL
ID to indicate that the battery level is full

See Also:
Constant Field Values

HE_MEMORY_LOW

public static final short HE_MEMORY_LOW
ID to indicate that pen memory is low

See Also:
Constant Field Values

HE_MEMORY_NORMAL

public static final short HE_MEMORY_NORMAL
ID to indicate that pen memory is normal

See Also:
Constant Field Values

HE_MIC_PLUGGED_IN

public static final short HE_MIC_PLUGGED_IN
ID to indicate that the mic is plugged in

See Also:
Constant Field Values

HE_MIC_PLUGGED_OUT

public static final short HE_MIC_PLUGGED_OUT
ID to indicate that the mic is plugged out

See Also:
Constant Field Values

HE_PHONES_PLUGGED_IN

public static final short HE_PHONES_PLUGGED_IN
ID to indicate that the headphones are plugged in

See Also:
Constant Field Values

HE_PHONES_UNPLUGGED

public static final short HE_PHONES_UNPLUGGED
ID to indicate that the headphones are plugged out

See Also:
Constant Field Values

HE_NOT_CHARGING

public static final short HE_NOT_CHARGING
ID to indicate that the pen is not currently charging

See Also:
Constant Field Values

HE_CHARGING

public static final short HE_CHARGING
ID to indicate that the pen is currently charging

See Also:
Constant Field Values

HE_CHARGING_COMPLETE

public static final short HE_CHARGING_COMPLETE
ID to indicate that the pen charging is complete

See Also:
Constant Field Values

HE_USB_CONNECTED

public static final short HE_USB_CONNECTED
ID to indicate that the pen is connected via USB

See Also:
Constant Field Values

HE_USB_DISCONNECTED

public static final short HE_USB_DISCONNECTED
ID to indicate that the pen is not connected via USB

See Also:
Constant Field Values

HE_BATTERY_DISCHARGED

public static final short HE_BATTERY_DISCHARGED
ID to indicate that the pen battery is discharged

See Also:
Constant Field Values

HE_MEMORY_FULL

public static final short HE_MEMORY_FULL
ID to indicate that the pen memory is full

See Also:
Constant Field Values

BatteryLow

public static final HardwareEvent BatteryLow
HardwareEvent to indicate that pen battery is low


BatteryNormal

public static final HardwareEvent BatteryNormal
HardwareEvent to indicate that pen battery is normal


BatteryFull

public static final HardwareEvent BatteryFull
HardwareEvent to indicate that pen battery is full


MemoryLow

public static final HardwareEvent MemoryLow
HardwareEvent to indicate that pen memory is low


MemoryNormal

public static final HardwareEvent MemoryNormal
HardwareEvent to indicate that pen memory is normal


MemoryFull

public static final HardwareEvent MemoryFull
HardwareEvent to indicate that pen memory is full


BatteryDischarged

public static final HardwareEvent BatteryDischarged
HardwareEvent to indicate that pen battery is discharged


AbortQuickRecord

public static final HardwareEvent AbortQuickRecord
HardwareEvent to indicate that quick record has been stopped

Method Detail

toString

public String toString()
Return a String representation of the HardwareEvent

Overrides:
toString in class SystemEvent
Returns:
String representation of the HardwareEvent

PenProfile 2.x

Copyright © 2010 Livescribe Inc. All Rights Reserved.
Confidential and subject to NDA.