cusack.hcg.events.graph

Class VertexAddedEvent

java.lang.Object

cusack.hcg.events.BaseEvent<S>

cusack.hcg.events.MultiVertexEvent<PuzzleInstance>

cusack.hcg.events.MultiVertexGraphEditEvent

cusack.hcg.events.MultiVertexWithCoordinatesGraphEditEvent

cusack.hcg.events.SingleVertexWithCoordinatesGraphEditEvent

cusack.hcg.events.graph.VertexAddedEvent

All Implemented Interfaces:

Event<PuzzleInstance>, GraphEvent, OneVertexEvent, RecordableEvent

public class VertexAddedEvent
extends SingleVertexWithCoordinatesGraphEditEvent
implements GraphEvent

Fired when a vertex is added to a graph

Author:

Eric DePree, Modified by Chuck Cusack, Feb 2010

Constructor Summary

Constructors

Constructor and Description
VertexAddedEvent(MultiVertexEvent<PuzzleInstance> other)
VertexAddedEvent(PuzzleInstance game)
VertexAddedEvent(PuzzleInstance game, Vertex vertex)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultBeforeActionComment()
java.lang.String	getDefaultBetweenActionComment()
java.lang.String	getDefaultIntroductoryComment()
java.lang.String	getEventName() Return the name of the event for printing.
Event<PuzzleInstance>	inverseEvent() This is the method that will be called by the public method getInverseEvent.
void	reallyPerformEvent() Essentially the exact same thing as performEvent from all of the other event classes.
void	takebackSideEffects() Implement anything special that has to be done after a move has been taken back.

Methods inherited from class cusack.hcg.events.SingleVertexWithCoordinatesGraphEditEvent

getVertex, involvesMultipleVertices, involvesOneVertex, setVertex

Methods inherited from class cusack.hcg.events.MultiVertexGraphEditEvent

modifiedGraph

Methods inherited from class cusack.hcg.events.MultiVertexEvent

contains, containsAll, decodeData, getPrintableDetails, getVertex, getVertices, hasExactlyTheseVertices, isSameEvent, performEvent, reallyDecodeData, size, vertsToString

Methods inherited from class cusack.hcg.events.BaseEvent

canUserGenerate, clearComments, encodeEvent, encodeEvents, equals, getAfterActionComment, getBeforeActionComment, getBetweenActionComment, getGame, getIntroductoryComment, getInverseEvent, getRealAfterActionComment, getRealBeforeActionComment, getRealBetweenActionComment, getRealIntroductoryComment, getTimeSinceFirstEvent, hashCode, isCreatedFromConstructor, modifiedPuzzle, performInverseEvent, performTakebackEvent, setAfterActionComment, setBeforeActionComment, setBetweenActionComment, setCreatedFromConstructor, setGame, setIntroductoryComment, setTimeSinceFirstEvent, toString, toStringWithoutTime

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VertexAddedEvent

public VertexAddedEvent(PuzzleInstance game)

VertexAddedEvent

public VertexAddedEvent(PuzzleInstance game,
                        Vertex vertex)

VertexAddedEvent

public VertexAddedEvent(MultiVertexEvent<PuzzleInstance> other)

Method Detail

inverseEvent

public Event<PuzzleInstance> inverseEvent()

Description copied from class: BaseEvent

This is the method that will be called by the public method getInverseEvent. Although a bit weird, it is done this way because that method sets the time of the inverse event, so we want them to call that one. We don't want every class to have to remember to do that part.

Returns:

reallyPerformEvent

public void reallyPerformEvent()

Description copied from class: MultiVertexEvent

Essentially the exact same thing as performEvent from all of the other event classes. For subclasses of this, we need to do something before we perform the events so we override performEvent and subclasses implement this as if it were performEvent.

getDefaultIntroductoryComment

public java.lang.String getDefaultIntroductoryComment()

Specified by:

getDefaultIntroductoryComment in interface Event<PuzzleInstance>

Specified by:

getDefaultIntroductoryComment in class BaseEvent<PuzzleInstance>

getDefaultBeforeActionComment

public java.lang.String getDefaultBeforeActionComment()

Specified by:

getDefaultBeforeActionComment in interface Event<PuzzleInstance>

Specified by:

getDefaultBeforeActionComment in class BaseEvent<PuzzleInstance>

getDefaultBetweenActionComment

public java.lang.String getDefaultBetweenActionComment()

Specified by:

getDefaultBetweenActionComment in interface Event<PuzzleInstance>

Specified by:

getDefaultBetweenActionComment in class BaseEvent<PuzzleInstance>

getEventName

public java.lang.String getEventName()

Description copied from class: BaseEvent

Return the name of the event for printing.

Specified by:

getEventName in class BaseEvent<PuzzleInstance>

Returns:

takebackSideEffects

public void takebackSideEffects()

Description copied from interface: Event

Implement anything special that has to be done after a move has been taken back. For instance, if it is a pebbling move, a vertex might need to be listed as uncovered, but that isn't a normal part of undoing a pebble move.

Specified by:

takebackSideEffects in interface Event<PuzzleInstance>

Overrides:

takebackSideEffects in class MultiVertexGraphEditEvent