fi.helsinki.dacopan.animseq
Class ScenarioItemPause

java.lang.Object
  fi.helsinki.dacopan.animseq.ScenarioItemPause

All Implemented Interfaces:

ScenarioItem

Direct Known Subclasses:

ScenarioItemEndMarker

public class ScenarioItemPause
extends java.lang.Object
implements ScenarioItem

A non-showable marker item for a pause in the play list.

Constructor Summary

ScenarioItemPause()
Creates a new instance of ScenarioItemPause

Method Summary

void	doAction(MainFrame mainFrame, boolean inRecordingMode) Does nothing.
java.lang.String	getPlaylistText() Returns a short text representation of the scenario item for presentation in the playlist.
boolean	getShowable() Always returns false.
boolean	recordEnd(float nowTime) Does nothing, always returns true.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScenarioItemPause

public ScenarioItemPause()

Creates a new instance of ScenarioItemPause

Method Detail

doAction

public void doAction(MainFrame mainFrame,
                     boolean inRecordingMode)

Does nothing.

Specified by:

doAction in interface ScenarioItem

Parameters:

mainFrame - A reference to a MainFrame instance in order to be able to carry out necessary mode changes.

inRecordingMode - Tells the item if the AnimationSequence is in recording mode or not. If true, the item should refraing from any potentially confusing mode changes, like automatically putting AnimationTimeState in play mode.

getPlaylistText

public java.lang.String getPlaylistText()

Description copied from interface: ScenarioItem

Returns a short text representation of the scenario item for presentation in the playlist.

Specified by:

getPlaylistText in interface ScenarioItem

recordEnd

public boolean recordEnd(float nowTime)

Does nothing, always returns true.

Specified by:

recordEnd in interface ScenarioItem

Returns:

True if recording the end was successful, false if not. The animation sequence is only allowed to move into recording the next item if the recording was successful.

getShowable

public boolean getShowable()

Always returns false.

Specified by:

getShowable in interface ScenarioItem