net.sf.gridarta.action

Class LightVisibleAction

java.lang.Object

net.sf.gridarta.action.LightVisibleAction

All Implemented Interfaces:

EditorAction

public class LightVisibleAction
extends java.lang.Object
implements EditorAction

An EditorAction that toggles whether map lighting is visible.

Constructor Summary

Constructors

Constructor and Description
LightVisibleAction(@NotNull MapViewSettings mapViewSettings) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	isLightVisible() Action method for "light visible".
void	setAction(@NotNull javax.swing.Action action, @NotNull java.lang.String name) Sets the Action instance for this editor action.
void	setLightVisible(boolean lightVisible) Sets whether the light of the current map should be visible.

Methods inherited from class java.lang.Object

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

Constructor Detail

LightVisibleAction

public LightVisibleAction(@NotNull
                          @NotNull MapViewSettings mapViewSettings)

Creates a new instance.

Parameters:

mapViewSettings - the map view settings instance to use

Method Detail

isLightVisible

@ActionMethod
public boolean isLightVisible()

Action method for "light visible".

Returns:

true if the light is visible, or false if the light is invisible

setLightVisible

@ActionMethod
public void setLightVisible(boolean lightVisible)

Sets whether the light of the current map should be visible.

Parameters:

lightVisible - new visibility of light in current map, true if the light should be visible, false if invisible

See Also:

isLightVisible()

setAction

public void setAction(@NotNull
                      @NotNull javax.swing.Action action,
                      @NotNull
                      @NotNull java.lang.String name)

Description copied from interface: EditorAction

Sets the Action instance for this editor action.

Specified by:

setAction in interface EditorAction

Parameters:

action - the action instance

name - the name of the action