net.sf.gridarta.gui.panel.tools

Class SelectionTool<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

java.lang.Object

net.sf.gridarta.gui.panel.tools.AbstractTool<G,A,R>

net.sf.gridarta.gui.panel.tools.BasicAbstractTool<G,A,R>

net.sf.gridarta.gui.panel.tools.SelectionTool<G,A,R>

All Implemented Interfaces:

MouseOpListener<G,A,R>, Tool<G,A,R>

public class SelectionTool<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends BasicAbstractTool<G,A,R>

Tool for Selection.

Constructor Summary

Constructors

Constructor and Description
SelectionTool(@NotNull ObjectChooser<G,A,R> objectChooser, @NotNull InsertionModeSet<G,A,R> insertionModeSet) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	clicked(@NotNull MouseOpEvent<G,A,R> e) Mouse was clicked.
@Nullable java.awt.Component	createOptionsView() Creates a view for changing the options of this tool.
void	dragged(@NotNull MouseOpEvent<G,A,R> e) Mouse was dragged.
boolean	isSelectionToolAutoFill() Returns whether auto-fill is enabled.
void	moved(@NotNull MouseOpEvent<G,A,R> e) Mouse was moved.
void	pressed(@NotNull MouseOpEvent<G,A,R> e) Mouse was pressed.
void	released(@NotNull MouseOpEvent<G,A,R> e) Mouse was released.
void	setSelectionToolAutoFill(boolean selectionToolAutoFill) Sets whether auto-fill is enabled.

Methods inherited from class net.sf.gridarta.gui.panel.tools.BasicAbstractTool

getId

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectionTool

public SelectionTool(@NotNull
                     @NotNull ObjectChooser<G,A,R> objectChooser,
                     @NotNull
                     @NotNull InsertionModeSet<G,A,R> insertionModeSet)

Creates a new instance.

Parameters:

objectChooser - the object chooser to update

insertionModeSet - the insertion mode set to use

Method Detail

pressed

public void pressed(@NotNull
                    @NotNull MouseOpEvent<G,A,R> e)

Description copied from interface: MouseOpListener

Mouse was pressed.

Parameters:

e - the event

clicked

public void clicked(@NotNull
                    @NotNull MouseOpEvent<G,A,R> e)

Description copied from interface: MouseOpListener

Mouse was clicked.

Parameters:

e - the event

dragged

public void dragged(@NotNull
                    @NotNull MouseOpEvent<G,A,R> e)

Description copied from interface: MouseOpListener

Mouse was dragged.

Parameters:

e - the event

moved

public void moved(@NotNull
                  @NotNull MouseOpEvent<G,A,R> e)

Description copied from interface: MouseOpListener

Mouse was moved.

Parameters:

e - the event

released

public void released(@NotNull
                     @NotNull MouseOpEvent<G,A,R> e)

Description copied from interface: MouseOpListener

Mouse was released.

Parameters:

e - the event

createOptionsView

@Nullable
public @Nullable java.awt.Component createOptionsView()

Description copied from interface: Tool

Creates a view for changing the options of this tool.

Returns:

view for changing the options of this tool or null if this tool hasn't any options

isSelectionToolAutoFill

@ActionMethod
public boolean isSelectionToolAutoFill()

Returns whether auto-fill is enabled.

Returns:

whether auto-fill is enabled

setSelectionToolAutoFill

@ActionMethod
public void setSelectionToolAutoFill(boolean selectionToolAutoFill)

Sets whether auto-fill is enabled.

Parameters:

selectionToolAutoFill - whether auto-fill is enabled