net.sf.magicproject.action.objectmap
Class ObjectMap

java.lang.Object
  net.sf.magicproject.action.MAction
      net.sf.magicproject.action.UserAction
          net.sf.magicproject.action.objectmap.ObjectMap

All Implemented Interfaces:

StandardAction

public abstract class ObjectMap
extends UserAction
implements StandardAction

Since:

0.90

Author:

Fabrice Daugan

Method Summary

Actiontype	getIdAction() Return the index of this action.
abstract boolean	play(ContextEventListener context, Ability ability) Generate event associated to this action.
java.lang.String	toHtmlString(Ability ability, int times, ContextEventListener context) Return the HTML code representing this action.
abstract java.lang.String	toString(Ability ability) String representation of this action.

Methods inherited from class net.sf.magicproject.action.UserAction

getActionName, manaNeeded, toHtmlString

Methods inherited from class net.sf.magicproject.action.MAction

equal, parseTest, toString

Methods inherited from class java.lang.Object

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

Method Detail

getIdAction

public final Actiontype getIdAction()

Description copied from class: MAction

Return the index of this action. As default, this is a zero id

Specified by:

getIdAction in class UserAction

Returns:

the index of this action.

See Also:

Actiontype

play

public abstract boolean play(ContextEventListener context,
                             Ability ability)

Description copied from interface: StandardAction

Generate event associated to this action. Only one or several events are generated and may be collected by event listeners. Then play this action

Specified by:

play in interface StandardAction

Parameters:

context - is the context attached to this action.

ability - is the ability owning this test. The card component of this ability should correspond to the card owning this test too.

Returns:

true if the stack can be resolved just after this call.

toString

public abstract java.lang.String toString(Ability ability)

Description copied from class: MAction

String representation of this action.

Specified by:

toString in class UserAction

Parameters:

ability - is the ability owning this test. The card component of this ability should correspond to the card owning this test too.

Returns:

action name.

See Also:

Object.toString()

toHtmlString

public final java.lang.String toHtmlString(Ability ability,
                                           int times,
                                           ContextEventListener context)

Description copied from class: MAction

Return the HTML code representing this action. If this action is named, it's name will be returned. If not, if existing, the picture associated to this action is returned. Otherwise, built-in action's text will be returned.

Overrides:

toHtmlString in class UserAction

Parameters:

ability - is the ability owning this test. The card component of this ability should correspond to the card owning this test too.

times - the times to repeat this action.

context - is the context attached to this action.

Returns:

the HTML code representing this action. If this action is named, it's name will be returned. If not, if existing, the picture associated to this action is returned. Otherwise, built-in action's text will be returned.

See Also:

MAction.toString(Ability), MAction.toHtmlString(Ability, ContextEventListener)