rle.core.ui
Class UiActionBase

java.lang.Object
  javax.swing.AbstractAction
      rle.core.ui.UiActionBase

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action, UiAction, PlugIn

Direct Known Subclasses:

FullScreenToggle, GetItem, GlobalCancel, ItemCommands, ItemCommands.RemoveTable, ItemCommands.SetTable, ItemCommands.ToggleTableVisibility, ItemUiActionBase, Look, Mover, StairCase, WarpToLevel

public abstract class UiActionBase
extends javax.swing.AbstractAction
implements UiAction

Base class for classes that perform an action in response to a UI event, such as a keypress. In general, any action should NOT run on the event dispatch thread, i.e. should run in a background thread.

See Also:

Serialized Form

Field Summary

protected InfoView	config
protected GameContext	context
protected java.lang.String	parameters

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

UiActionBase()

Method Summary

void	actionPerformed(java.awt.event.ActionEvent event) Entry method triggered by key stroke.
InfoView	config() Returns the configuration InfoView used to create this PlugIn.
GameContext	getContext() For convenience.
java.awt.event.ActionEvent	getEvent() The AWT/Swing event that triggered this action.
java.lang.String	getParameters()
java.util.Map<java.lang.String,java.lang.String>	paramMap() Provide access to parameters set via setParameters().
void	setConfig(InfoView view) Set the configuring InfoView.
void	setParameters(java.lang.String parameters) Set parameters.

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface rle.core.ui.UiAction

doAction

Methods inherited from interface javax.swing.Action

addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Field Detail

parameters

protected java.lang.String parameters

config

protected InfoView config

context

protected GameContext context

Constructor Detail

UiActionBase

public UiActionBase()

Method Detail

getEvent

public java.awt.event.ActionEvent getEvent()

Description copied from interface: UiAction

The AWT/Swing event that triggered this action.

Specified by:

getEvent in interface UiAction

actionPerformed

public final void actionPerformed(java.awt.event.ActionEvent event)

Entry method triggered by key stroke.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

setParameters

public void setParameters(java.lang.String parameters)

Description copied from interface: PlugIn

Set parameters.

Specified by:

setParameters in interface PlugIn

getParameters

public java.lang.String getParameters()

paramMap

public java.util.Map<java.lang.String,java.lang.String> paramMap()

Description copied from interface: PlugIn

Provide access to parameters set via setParameters().

Specified by:

paramMap in interface PlugIn

getContext

public GameContext getContext()

For convenience.

Specified by:

getContext in interface PlugIn

setConfig

public void setConfig(InfoView view)

Description copied from interface: PlugIn

Set the configuring InfoView.

Specified by:

setConfig in interface PlugIn

config

public InfoView config()

Description copied from interface: PlugIn

Returns the configuration InfoView used to create this PlugIn. See InfoView.createPlugIn(String).

Specified by:

config in interface PlugIn