fr.emn.win32input.jwintab
Class TabletDevice

java.lang.Object
  extended byfr.emn.win32input.jwintab.TabletDevice

public class TabletDevice
extends java.lang.Object


Field Summary
static int ALL
          Use this to combine all dimensions.
static int[] DIMENSIONS_LIST
          Used to browse dimensions separatedly.
static int PRESSURE
          Normal pressure dimension
static int TANGENT_PRESSURE
          Tangential pressure dimension
static int TILT
          TILT = TILT_AZIMUTH | TILT_ALTITUDE | TILT_TWIST.
static int TILT_ALTITUDE
          Tilt dimension.
static int TILT_AZIMUTH
          Tilt dimension.
static int TILT_TWIST
          Tilt dimension.
static int X
          X dimension
static int XY
          XY = X | Y.
static int XYZ
          XYZ = X | Y | Z.
static int Y
          Y dimension
static int Z
          Z dimension
 
Method Summary
static java.lang.String dimensionToShortString(int dimension)
          Returns a short String representation of the dimension(s) used in Devices.
static java.lang.String dimensionToString(int dimension)
          Returns a String representation of the dimension(s).
 TabletCursor[] getCursors()
          Returns an array of Cursor objects describing the cursor types supported by the device.
 int getCursorTypeCount()
          Returns the number of supported cursor types.
 java.lang.String getDeviceName()
          Returns a String describing the device, manufacturer, and revision level.
 int getDimensions()
          Returns a bit mask indicating which dimensions are supported.
 int[] getDimensionsList()
          Same as getDimensions(), except that it returns supported dimensions in an array.
 Domain getDomain()
          Returns a Domain object representing the overall logical domain of the tablet.
 int getID()
           
 int getMaxReportRate()
          Returns the maximum packet report in Hertz.
 int getOptionalDimensions()
          Returns a bit mask indicating which dimensions are optional (i.e. cursor-specific).
 int getPhysAbsoluteDimensions()
          Returns a bit mask indicating which dimensions are physically absolute.
 PhysicalRange getPhysicalRange(int dimension)
          Returns a PhysicalRange object describing the dimension's logical domain, unit and resolution.
 boolean isDisplayIntegrated()
          Returns true if the display and digitizer share the same surface.
 boolean isReportingProximity()
          Returns true if the device can generate events when the cursor is entering and leaving the physical detection range.
 boolean isSensing(int dimension)
          Returns true if the device supports the given dimension(s).
 boolean isSupportingCursorIDs()
          Returns true if the device can uniquely identify the active cursor in hardware.
 boolean isTouchOnly()
          Returns true if the cursor must be in physical contact with the device to report position.
static int[] toDimensionList(int dimension)
          Converts supported dimensions into an array.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

X

public static final int X
X dimension

See Also:
Constant Field Values

Y

public static final int Y
Y dimension

See Also:
Constant Field Values

Z

public static final int Z
Z dimension

See Also:
Constant Field Values

PRESSURE

public static final int PRESSURE
Normal pressure dimension

See Also:
Constant Field Values

TANGENT_PRESSURE

public static final int TANGENT_PRESSURE
Tangential pressure dimension

See Also:
Constant Field Values

TILT_AZIMUTH

public static final int TILT_AZIMUTH
Tilt dimension. Specifies the clockwise rotation of the cursor about the z axis through a full circular angle

See Also:
Constant Field Values

TILT_ALTITUDE

public static final int TILT_ALTITUDE
Tilt dimension. Specifies the angle with the x-y plane through a signed, semi- circular angle. Positive values specify an angle upward toward the positive z axis; negative values specify an angle downward toward the negative z axis.

See Also:
Constant Field Values

TILT_TWIST

public static final int TILT_TWIST
Tilt dimension. Specifies the clockwise rotation of the cursor about its own major axis.

See Also:
Constant Field Values

TILT

public static final int TILT
TILT = TILT_AZIMUTH | TILT_ALTITUDE | TILT_TWIST. Use this to combine all tilt dimensions.

See Also:
Constant Field Values

XY

public static final int XY
XY = X | Y. Use this to combine X and Y dimensions.

See Also:
Constant Field Values

XYZ

public static final int XYZ
XYZ = X | Y | Z. Use this to combine X, Y and Z dimensions.

See Also:
Constant Field Values

ALL

public static final int ALL
Use this to combine all dimensions.

See Also:
Constant Field Values

DIMENSIONS_LIST

public static final int[] DIMENSIONS_LIST
Used to browse dimensions separatedly. This array contains the 8 tablet dimensions.

Method Detail

dimensionToShortString

public static java.lang.String dimensionToShortString(int dimension)
Returns a short String representation of the dimension(s) used in Devices.


dimensionToString

public static java.lang.String dimensionToString(int dimension)
Returns a String representation of the dimension(s).


getCursors

public TabletCursor[] getCursors()
Returns an array of Cursor objects describing the cursor types supported by the device.

See Also:
TabletCursor

getCursorTypeCount

public int getCursorTypeCount()
Returns the number of supported cursor types.


getDeviceName

public java.lang.String getDeviceName()
Returns a String describing the device, manufacturer, and revision level.


getDimensions

public int getDimensions()
Returns a bit mask indicating which dimensions are supported. Some are always available, some are only available when certain cursors are connected. The individual cursor descriptions must be consulted to determine which cursors support which dimensions.

Returns:
a bit mask describing one or more dimension(s).
See Also:
getOptionalDimensions(), TabletCursor.getCursorDimensions()

getDimensionsList

public int[] getDimensionsList()
Same as getDimensions(), except that it returns supported dimensions in an array. Dimensions are separated, so that they are easier to use in a loop.


getDomain

public Domain getDomain()
Returns a Domain object representing the overall logical domain of the tablet. Only dimensions sensed by the tablet will be represented.

See Also:
Domain

getID

public int getID()

getMaxReportRate

public int getMaxReportRate()
Returns the maximum packet report in Hertz.


getOptionalDimensions

public int getOptionalDimensions()
Returns a bit mask indicating which dimensions are optional (i.e. cursor-specific).

Returns:
a bit mask describing one or more dimension(s).
See Also:
getDimensions()

getPhysAbsoluteDimensions

public int getPhysAbsoluteDimensions()
Returns a bit mask indicating which dimensions are physically absolute. Most often, tablet hardware report absolute measurement. However, some dimensions may be physically relative, i.e. the hardware can only report change, not absolute measurement. Physically absolute dimensions can report absolute or relative logical values, whereas physically relative dimensions can only report relative logical values.

See Also:
TabletContext.getAbsoluteDimensions()

getPhysicalRange

public PhysicalRange getPhysicalRange(int dimension)
Returns a PhysicalRange object describing the dimension's logical domain, unit and resolution. Returns null if the dimension is not supported.

See Also:
isSensing(int), PhysicalRange

isDisplayIntegrated

public boolean isDisplayIntegrated()
Returns true if the display and digitizer share the same surface.


isReportingProximity

public boolean isReportingProximity()
Returns true if the device can generate events when the cursor is entering and leaving the physical detection range.


isSensing

public boolean isSensing(int dimension)
Returns true if the device supports the given dimension(s).

See Also:
getPhysicalRange(int), getDimensions()

isSupportingCursorIDs

public boolean isSupportingCursorIDs()
Returns true if the device can uniquely identify the active cursor in hardware.


isTouchOnly

public boolean isTouchOnly()
Returns true if the cursor must be in physical contact with the device to report position.


toDimensionList

public static int[] toDimensionList(int dimension)
Converts supported dimensions into an array. Dimensions are separated, so that they are easier to use in a loop.