edu.berkeley.guir.ptk.transition
Interface Animatable

All Known Implementing Classes:

BusLEDOutput, BusLEDOutputTest, GraphicalTextOutput, IconOutput, OrbOutput

public interface Animatable

Outputs that want transitions must implement this interface. Transitions implement a mechanism for creating certain effects on the output appropriate to an event's notification level. For example, events with change blind notification levels should be displayed in a way that minimally attracts the user's attention.

Transitions are made up of chains of events displayed in order by an Output. The methods in this interface provide events that are part of this chain. The ordering of the chain is determined by the Transition class.

Method Summary

Event	alternateStep(Event prev_event, Event new_event, int display_step) Returns an event that represents the "alternate" or "opposite" of what is displayed by the other transition methods in order to create a "flashing" effect.
Event	changeblindTransStep(Event prev_event, Event new_event, int display_step) Returns an event that is somewhere between the start and end points of a change blind transition, depending on the display_step and the number of steps involved in the transition.
Event	endTransition(Event prev_event, Event new_event, int display_step) Returns an event representative of the end state of a transition.
Event	interruptTransStep(Event prev_event, Event new_event, int display_step) Returns an event that is somewhere between the start and end points of a interrupt transition, depending on the display_step and the number of steps involved in the transition.
Event	makeawareTransStep(Event prev_event, Event new_event, int display_step) Returns an event that is somewhere between the start and end points of a make aware transition, depending on the display_step and the number of steps involved in the transition.
Event	startTransition(Event prev_event, Event new_event, int display_step) Returns an event representative of the beginning of a transition.

Method Detail

startTransition

public Event startTransition(Event prev_event,
                             Event new_event,
                             int display_step)

Returns an event representative of the beginning of a transition.

Parameters:

prev_event - the previous event sent to this Output (null if the new event is the first).

new_event - the new event to be displayed on the Output.

display_step - a number indicating the display order of the event returned if the Transition is creating a set of events.

Returns:

Event

endTransition

public Event endTransition(Event prev_event,
                           Event new_event,
                           int display_step)

Returns an event representative of the end state of a transition. This typically involves the new event data.

Parameters:

prev_event - the previous event sent to this Output (null if the new event is the first).

new_event - the new event to be displayed on the Output.

display_step - a number indicating the display order of the event returned if the Transition is creating a set of events.

Returns:

Event

changeblindTransStep

public Event changeblindTransStep(Event prev_event,
                                  Event new_event,
                                  int display_step)

Returns an event that is somewhere between the start and end points of a change blind transition, depending on the display_step and the number of steps involved in the transition. Only need to implement if the application uses change blind transitions.

Parameters:

prev_event - the previous event sent to this Output (null if the new event is the first).

new_event - the new event to be displayed on the Output.

display_step - a number indicating the display order of the event returned if the Transition is creating a set of events.

Returns:

Event

makeawareTransStep

public Event makeawareTransStep(Event prev_event,
                                Event new_event,
                                int display_step)

Returns an event that is somewhere between the start and end points of a make aware transition, depending on the display_step and the number of steps involved in the transition. Only need to implement if the application uses make aware transitions.

Parameters:

prev_event - the previous event sent to this Output (null if the new event is the first).

new_event - the new event to be displayed on the Output.

display_step - a number indicating the display order of the event returned if the Transition is creating a set of events.

Returns:

Event

interruptTransStep

public Event interruptTransStep(Event prev_event,
                                Event new_event,
                                int display_step)

Returns an event that is somewhere between the start and end points of a interrupt transition, depending on the display_step and the number of steps involved in the transition. Only need to implement if the application uses interrupt transitions.

Parameters:

prev_event - the previous event sent to this Output (null if the new event is the first).

new_event - the new event to be displayed on the Output.

display_step - a number indicating the display order of the event returned if the Transition is creating a set of events.

Returns:

Event

alternateStep

public Event alternateStep(Event prev_event,
                           Event new_event,
                           int display_step)

Returns an event that represents the "alternate" or "opposite" of what is displayed by the other transition methods in order to create a "flashing" effect. For example, if a text is displayed on a ticker, the alternateStep might be to delete all the text. For an interrupt transition, the effect would be text flashing between the the new event text (returned by endTransition) and no text (returned by alternateStep).

Parameters:

prev_event - the previous event sent to this Output (null if the new event is the first).

new_event - the new event to be displayed on the Output.

display_step - a number indicating the display order of the event returned if the Transition is creating a set of events.

Returns:

Event