com.google.appinventor.components.runtime

Class ProximitySensor

java.lang.Object

com.google.appinventor.components.runtime.AndroidNonvisibleComponent

com.google.appinventor.components.runtime.ProximitySensor

All Implemented Interfaces:

android.hardware.SensorEventListener, Component, Deleteable, OnPauseListener, OnResumeListener, OnStopListener, SensorComponent

public class ProximitySensor
extends AndroidNonvisibleComponent
implements OnStopListener, OnResumeListener, SensorComponent, OnPauseListener, android.hardware.SensorEventListener, Deleteable

Field Summary

Fields inherited from class com.google.appinventor.components.runtime.AndroidNonvisibleComponent

form

Fields inherited from interface com.google.appinventor.components.runtime.Component

ACCELEROMETER_SENSITIVITY_MODERATE, ACCELEROMETER_SENSITIVITY_STRONG, ACCELEROMETER_SENSITIVITY_WEAK, ALIGNMENT_CENTER, ALIGNMENT_NORMAL, ALIGNMENT_OPPOSITE, ASSET_DIRECTORY, BUTTON_SHAPE_DEFAULT, BUTTON_SHAPE_OVAL, BUTTON_SHAPE_RECT, BUTTON_SHAPE_ROUNDED, COLOR_BLACK, COLOR_BLUE, COLOR_CYAN, COLOR_DEFAULT, COLOR_DKGRAY, COLOR_GRAY, COLOR_GREEN, COLOR_LTGRAY, COLOR_MAGENTA, COLOR_NONE, COLOR_ORANGE, COLOR_PINK, COLOR_RED, COLOR_WHITE, COLOR_YELLOW, DEFAULT_VALUE_COLOR_BLACK, DEFAULT_VALUE_COLOR_BLUE, DEFAULT_VALUE_COLOR_CYAN, DEFAULT_VALUE_COLOR_DEFAULT, DEFAULT_VALUE_COLOR_DKGRAY, DEFAULT_VALUE_COLOR_GRAY, DEFAULT_VALUE_COLOR_GREEN, DEFAULT_VALUE_COLOR_LTGRAY, DEFAULT_VALUE_COLOR_MAGENTA, DEFAULT_VALUE_COLOR_NONE, DEFAULT_VALUE_COLOR_ORANGE, DEFAULT_VALUE_COLOR_PINK, DEFAULT_VALUE_COLOR_RED, DEFAULT_VALUE_COLOR_WHITE, DEFAULT_VALUE_COLOR_YELLOW, DIRECTION_EAST, DIRECTION_MAX, DIRECTION_MIN, DIRECTION_NONE, DIRECTION_NORTH, DIRECTION_NORTHEAST, DIRECTION_NORTHWEST, DIRECTION_SOUTH, DIRECTION_SOUTHEAST, DIRECTION_SOUTHWEST, DIRECTION_WEST, FONT_DEFAULT_SIZE, LAYOUT_ORIENTATION_HORIZONTAL, LAYOUT_ORIENTATION_VERTICAL, LENGTH_FILL_PARENT, LENGTH_PREFERRED, LENGTH_UNKNOWN, SLIDER_MAX_VALUE, SLIDER_MIN_VALUE, SLIDER_THUMB_VALUE, TOAST_LENGTH_LONG, TOAST_LENGTH_SHORT, TYPEFACE_DEFAULT, TYPEFACE_MONOSPACE, TYPEFACE_SANSSERIF, TYPEFACE_SERIF

Constructor Summary

Constructors

Constructor and Description
ProximitySensor(ComponentContainer container) Creates a new ProximitySensor component.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	Available() Used to determine if the device has ProximitySensor
float	Distance() Returns the distance.
boolean	Enabled() If true, the sensor will generate events.
void	Enabled(boolean enabled) Specifies whether the sensor should generate events.
boolean	KeepRunningWhenOnPause() Returns value of keepRunningWhenOnPause
void	KeepRunningWhenOnPause(boolean enabled) Specifies if sensor should still be listening when activity is not active
float	MaximumRange() Determines a sensor's maximum range.
void	onAccuracyChanged(android.hardware.Sensor sensor, int accuracy) Called when the accuracy of the registered sensor has changed
void	onDelete()
void	onPause()
void	onResume()
void	onSensorChanged(android.hardware.SensorEvent sensorEvent) Called when sensor values have changed
void	onStop()
void	ProximityChanged(float distance)

Methods inherited from class com.google.appinventor.components.runtime.AndroidNonvisibleComponent

getDispatchDelegate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.appinventor.components.runtime.Component

getDispatchDelegate

Constructor Detail

ProximitySensor

public ProximitySensor(ComponentContainer container)

Creates a new ProximitySensor component.

Parameters:

container - ignored (because this is a non-visible component)

Method Detail

Available

public boolean Available()

Used to determine if the device has ProximitySensor

Returns:

true indicates that an proximity sensor is available, false that it isn't

onResume

public void onResume()

Specified by:

onResume in interface OnResumeListener

onStop

public void onStop()

Specified by:

onStop in interface OnStopListener

onDelete

public void onDelete()

Specified by:

onDelete in interface Deleteable

onPause

public void onPause()

Specified by:

onPause in interface OnPauseListener

onSensorChanged

public void onSensorChanged(android.hardware.SensorEvent sensorEvent)

Called when sensor values have changed

Specified by:

onSensorChanged in interface android.hardware.SensorEventListener

Parameters:

sensorEvent - holds information such as the sensor's type, the time-stamp, accuracy and sensor's data

MaximumRange

public float MaximumRange()

Determines a sensor's maximum range. Some proximity sensors return binary values that represent "near" or "far." In this case, the sensor usually reports its maximum range value in the far state and a lesser value in the near state. Typically, the far value is a value > 5 cm, but this can vary from sensor to sensor.

Returns:

Sensor's maximum range.

Enabled

public boolean Enabled()

If true, the sensor will generate events. Otherwise, no events are generated .

Returns:

true indicates that the sensor generates events, false that it doesn't

Enabled

public void Enabled(boolean enabled)

Specifies whether the sensor should generate events. If true, the sensor will generate events. Otherwise, no events are generated.

Parameters:

enabled - true enables sensor event generation, false disables it

KeepRunningWhenOnPause

public boolean KeepRunningWhenOnPause()

Returns value of keepRunningWhenOnPause

KeepRunningWhenOnPause

public void KeepRunningWhenOnPause(boolean enabled)

Specifies if sensor should still be listening when activity is not active

Parameters:

enabled -

ProximityChanged

public void ProximityChanged(float distance)

Distance

public float Distance()

Returns the distance. The sensor must be enabled to return meaningful values.

Returns:

distance

onAccuracyChanged

public void onAccuracyChanged(android.hardware.Sensor sensor,
                     int accuracy)

Called when the accuracy of the registered sensor has changed

Specified by:

onAccuracyChanged in interface android.hardware.SensorEventListener

Parameters:

sensor - Sensor

accuracy - the new accuracy of this sensor