net.sf.gridarta.model.mapcontrol

Interface MapControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

All Known Implementing Classes:

DefaultMapControl

public interface MapControl<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Currently nothing more than a marker interface for unification.

Method Summary

Modifier and Type	Method and Description
void	acquire() Increases the use counter.
void	addMapControlListener(@NotNull MapControlListener<G,A,R> listener) Registers a MapControlListener.
@NotNull MapModel<G,A,R>	getMapModel() Returns the map model.
int	getUseCounter() Returns the use counter.
boolean	isPickmap() Return flag that indicates whether this is a pickmap or not.
void	release() Decreases the use counter and possibly frees the map control.
void	removeMapControlListener(@NotNull MapControlListener<G,A,R> listener) Unregisters a MapControlListener.
void	save() Saves the map to a file.
void	saveAs(@NotNull MapFile mapFile) Saves the file with the given map file.

Method Detail

isPickmap

boolean isPickmap()

Return flag that indicates whether this is a pickmap or not.

Returns:

flag that indicates whether this is a pickmap or not

getMapModel

@NotNull
@NotNull MapModel<G,A,R> getMapModel()

Returns the map model.

Returns:

the map model

addMapControlListener

void addMapControlListener(@NotNull
                           @NotNull MapControlListener<G,A,R> listener)

Registers a MapControlListener.

Parameters:

listener - the listener to register

removeMapControlListener

void removeMapControlListener(@NotNull
                              @NotNull MapControlListener<G,A,R> listener)

Unregisters a MapControlListener.

Parameters:

listener - the listener to unregister

save

void save()
   throws java.io.IOException

Saves the map to a file.

Throws:

java.io.IOException - if saving fails

saveAs

void saveAs(@NotNull
            @NotNull MapFile mapFile)
     throws java.io.IOException

Saves the file with the given map file. This implicitly sets the map file and resets the modified state.

Parameters:

mapFile - the map file to be saved to

Throws:

java.io.IOException - if saving fails; in this case the modified flag is not reset

acquire

void acquire()

Increases the use counter.

release

void release()

Decreases the use counter and possibly frees the map control.

getUseCounter

int getUseCounter()

Returns the use counter.

Returns:

the use counter