lightbulb_outline Please take our October 2018 developer survey. Start survey

OrientationEventListener

public abstract class OrientationEventListener
extends Object

java.lang.Object
   ↳ android.view.OrientationEventListener


Helper class for receiving notifications from the SensorManager when the orientation of the device has changed.

Summary

Constants

int ORIENTATION_UNKNOWN

Returned from onOrientationChanged when the device orientation cannot be determined (typically when the device is in a close to flat position).

Public constructors

OrientationEventListener(Context context)

Creates a new OrientationEventListener.

OrientationEventListener(Context context, int rate)

Creates a new OrientationEventListener.

Public methods

boolean canDetectOrientation()
void disable()

Disables the OrientationEventListener.

void enable()

Enables the OrientationEventListener so it will monitor the sensor and call onOrientationChanged(int) when the device orientation changes.

abstract void onOrientationChanged(int orientation)

Called when the orientation of the device has changed.

Inherited methods

Constants

ORIENTATION_UNKNOWN

added in API level 3
public static final int ORIENTATION_UNKNOWN

Returned from onOrientationChanged when the device orientation cannot be determined (typically when the device is in a close to flat position).

Constant Value: -1 (0xffffffff)

Public constructors

OrientationEventListener

added in API level 3
public OrientationEventListener (Context context)

Creates a new OrientationEventListener.

Parameters
context Context: for the OrientationEventListener.

OrientationEventListener

added in API level 3
public OrientationEventListener (Context context, 
                int rate)

Creates a new OrientationEventListener.

Parameters
context Context: for the OrientationEventListener.

rate int: at which sensor events are processed (see also SensorManager). Use the default value of SENSOR_DELAY_NORMAL for simple screen orientation change detection.

Public methods

canDetectOrientation

added in API level 3
public boolean canDetectOrientation ()

Returns
boolean

disable

added in API level 3
public void disable ()

Disables the OrientationEventListener.

enable

added in API level 3
public void enable ()

Enables the OrientationEventListener so it will monitor the sensor and call onOrientationChanged(int) when the device orientation changes.

onOrientationChanged

added in API level 3
public abstract void onOrientationChanged (int orientation)

Called when the orientation of the device has changed. orientation parameter is in degrees, ranging from 0 to 359. orientation is 0 degrees when the device is oriented in its natural position, 90 degrees when its left side is at the top, 180 degrees when it is upside down, and 270 degrees when its right side is to the top. ORIENTATION_UNKNOWN is returned when the device is close to flat and the orientation cannot be determined.

Parameters
orientation int: The new orientation of the device.