me.adaptive.arp.api

Class RotationEvent

java.lang.Object

me.adaptive.arp.api.APIBean

me.adaptive.arp.api.RotationEvent

public class RotationEvent
extends APIBean

Object for reporting orientation change events for device and display.

Since:

v2.0.5

Constructor Summary

Constructors

Constructor and Description
RotationEvent() Default constructor.
RotationEvent(ICapabilitiesOrientation origin, ICapabilitiesOrientation destination, RotationEventState state, long timestamp) Convenience constructor.

Method Summary

Modifier and Type	Method and Description
ICapabilitiesOrientation	getDestination() Gets the destination orientation of the event.
ICapabilitiesOrientation	getOrigin() Get the origin orientation of the event.
RotationEventState	getState() Gets the current state of the event.
long	getTimestamp() Gets the timestamp in milliseconds of the event.
void	setDestination(ICapabilitiesOrientation destination) Sets the destination orientation of the event.
void	setOrigin(ICapabilitiesOrientation origin) Set the origin orientation of the event.
void	setState(RotationEventState state) Sets the current state of the event.
void	setTimestamp(long timestamp) Sets the timestamp in milliseconds of the event.

Methods inherited from class java.lang.Object

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

Constructor Detail

RotationEvent

public RotationEvent()

Default constructor.

Since:

v2.0.5

RotationEvent

public RotationEvent(ICapabilitiesOrientation origin,
                     ICapabilitiesOrientation destination,
                     RotationEventState state,
                     long timestamp)

Convenience constructor.

Parameters:

origin - Source orientation when the event was fired.

destination - Destination orientation when the event was fired.

state - State of the event (WillBegin, DidFinish).

timestamp - Timestamp in milliseconds when the event was fired.

Since:

v2.0.5

Method Detail

getDestination

public ICapabilitiesOrientation getDestination()

Gets the destination orientation of the event.

Returns:

Destination orientation.

Since:

v2.0.5

setDestination

public void setDestination(ICapabilitiesOrientation destination)

Sets the destination orientation of the event.

Parameters:

destination - Destination orientation.

Since:

v2.0.5

getOrigin

public ICapabilitiesOrientation getOrigin()

Get the origin orientation of the event.

Returns:

Origin orientation.

Since:

v2.0.5

setOrigin

public void setOrigin(ICapabilitiesOrientation origin)

Set the origin orientation of the event.

Parameters:

origin - Origin orientation

Since:

v2.0.5

getState

public RotationEventState getState()

Gets the current state of the event.

Returns:

State of the event.

Since:

v2.0.5

setState

public void setState(RotationEventState state)

Sets the current state of the event.

Parameters:

state - The state of the event.

Since:

v2.0.5

getTimestamp

public long getTimestamp()

Gets the timestamp in milliseconds of the event.

Returns:

Timestamp of the event.

Since:

v2.0.5

setTimestamp

public void setTimestamp(long timestamp)

Sets the timestamp in milliseconds of the event.

Parameters:

timestamp - Timestamp of the event.

Since:

v2.0.5