net.nexttext.behaviour
Class AbstractAction

java.lang.Object
  net.nexttext.behaviour.AbstractAction

All Implemented Interfaces:

Action

Direct Known Subclasses:

ApplyToGlyph, Chain, Colorize, Condition, CustomAction, DebugLog, Delay, Descend, DForm, DoNothing, FadeTo, Follow, FollowSibling, Kern, Kill, MoveBy, MoveTo, Multiplexer, OnCollision, PhysicsAction, RandomMotion, Repeat, Selector, Timer, Tracker

public abstract class AbstractAction
extends java.lang.Object
implements Action

An implementation of Action with some broadly useful functionality.

Abstract Action provides:

• Public PropertySet to hold Actions' modifiable properties. It is public so that components like UIs can tweak the way Actions work.
• Public DisplayName, useful for UIs which need to distinguish between multiple instances of the same action.
• Protected accessors for core TextObject properties. These are just short-cut methods to make it easier for subclasses to access standard properties. Some abstract subclasses (eg. PhysicsAction) provide similar accessors for other TextObject properties.
• Default implementations of the Action methods, which subclasses may wish to override.
• A protected map from TextObjects to action-specific data. This is used by subclasses to persist state information across frames about TextObjects currently being processed. The Action.complete() method will remove state information from this map, for the relevant TextObject.

Nested Class Summary

Nested classes/interfaces inherited from interface net.nexttext.behaviour.Action

Action.ActionResult

Constructor Summary

AbstractAction()


Method Summary

Action.ActionResult	behave(TextObject to) Default behave method for single objects.
Action.ActionResult	behave(TextObject[] to) Default behave method for object arrays.
Action.ActionResult	behave(TextObject toA, TextObject toB) Default behave method for object pairs.
void	complete(TextObject to) Default implementation which removes state information for the object.
java.lang.String	getDisplayName() Returns the display name of this instance.
java.util.Map<java.lang.String,Property>	getRequiredProperties() The properties that this action requires on a TextObject.
Behaviour	makeBehaviour() Creates a new Behaviour and wraps this action in it.
PropertySet	properties() Exposes this Action's property set.
void	setDisplayName(java.lang.String name) Sets the display name of this Action instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAction

public AbstractAction()

Method Detail

setDisplayName

public void setDisplayName(java.lang.String name)

Sets the display name of this Action instance.

Setting the empty string will return it to the default value, which is the name of the Action class.

getDisplayName

public java.lang.String getDisplayName()

Returns the display name of this instance. If no particular display name was specified, the class name is used by default.

properties

public PropertySet properties()

Exposes this Action's property set.

See Also:

PropertySet

behave

public Action.ActionResult behave(TextObject to)

Default behave method for single objects.

This method does nothing; it should be overriden by subclasses if they wish to support actions on single objects.

Trying to call this method on an Action which doesn't override it will throw an UnsupportedActionException.

Specified by:

behave in interface Action

Throws:

UnsupportedActionException

behave

public Action.ActionResult behave(TextObject toA,
                                  TextObject toB)

Default behave method for object pairs.

This method does nothing; it should be overriden by subclasses if they wish to support actions on pairs of objects.

Trying to call this method on an Action which doesn't override it will throw an UnsupportedActionException.

Specified by:

behave in interface Action

Throws:

UnsupportedActionException

behave

public Action.ActionResult behave(TextObject[] to)

Default behave method for object arrays. It will redirect to the proper behave method if the array is of size 1 or 2, otherwise it will throw an exception.

Specified by:

behave in interface Action

Throws:

UnsupportedActionException

complete

public void complete(TextObject to)

Default implementation which removes state information for the object.

Specified by:

complete in interface Action

getRequiredProperties

public java.util.Map<java.lang.String,Property> getRequiredProperties()

The properties that this action requires on a TextObject.

Right now this method always returns an empty map, since basic Actions should be restricted to use only the core set of TextObject properties.

If a subclass of Action requires a set of additional properties then it should override this method and return the appropriate Map containing the property objects.

This method is required by the Action interface.

Specified by:

getRequiredProperties in interface Action

makeBehaviour

public Behaviour makeBehaviour()

Creates a new Behaviour and wraps this action in it.

Returns:

the created Behaviour