me.adaptive.arp.api

Interface IDisplayOrientationListener

All Superinterfaces:

IAdaptiveRP, IBaseListener

All Known Implementing Classes:

DisplayOrientationListenerImpl

public interface IDisplayOrientationListener
extends IBaseListener

Interface for handling display orientation change events.

Since:

v2.0.5

Method Summary

Modifier and Type	Method and Description
void	onError(IDisplayOrientationListenerError error) Although extremely unlikely, this event will be fired if something beyond the control of the platform impedes the rotation of the display.
void	onResult(RotationEvent rotationEvent) Event fired with the successful start and finish of a rotation.
void	onWarning(RotationEvent rotationEvent, IDisplayOrientationListenerWarning warning) Event fired with a warning when the rotation is aborted.

Methods inherited from interface me.adaptive.arp.api.IBaseListener

getId

Methods inherited from interface me.adaptive.arp.api.IAdaptiveRP

getAPIGroup, getAPIVersion

Method Detail

onError

void onError(IDisplayOrientationListenerError error)

Although extremely unlikely, this event will be fired if something beyond the control of the platform impedes the rotation of the display.

Parameters:

error - The error condition... generally unknown as it is unexpected!

Since:

v2.0.5

onResult

void onResult(RotationEvent rotationEvent)

Event fired with the successful start and finish of a rotation.

Parameters:

rotationEvent - RotationEvent containing origin, destination and state of the event.

Since:

v2.0.5

onWarning

void onWarning(RotationEvent rotationEvent,
               IDisplayOrientationListenerWarning warning)

Event fired with a warning when the rotation is aborted. In specific, this event may be fired if the application vetoes display rotation before rotation is completed.

Parameters:

rotationEvent - RotationEvent containing origin, destination and state of the event.

warning - Type of condition that aborted rotation execution.

Since:

v2.0.5