com.realtime.crossfire.jxclient.shortcuts.Shortcuts Class Reference

Collaboration diagram for com.realtime.crossfire.jxclient.shortcuts.Shortcuts:

[legend]

List of all members.

Public Member Functions
	Shortcuts (@NotNull final CommandQueue commandQueue,@NotNull final SpellsManager spellsManager)
void	clearShortcuts ()
void	setShortcut (final int index,@Nullable final Shortcut shortcut)
void	unsetShortcut (final int index)
void	setSpellShortcut (final int index,@NotNull final String spellName, final boolean cast)
void	setSpellShortcut (final int index,@NotNull final Spell spell, final boolean cast)
void	setCommandShortcut (final int index,@NotNull final String command)
void	executeShortcut (final int index)
void	addShortcutsListener (@NotNull final ShortcutsListener listener)
void	removeShortcutsListener (@NotNull final ShortcutsListener listener)
boolean	isModified ()
void	resetModified ()
File	getFile ()
void	setFile (@Nullable final File file)
Iterator< Shortcut >	iterator ()

---

Detailed Description

Manages a list of Shortcuts.

Author:

Andreas Kirschbaum

Definition at line 39 of file Shortcuts.java.

---

Constructor & Destructor Documentation

com.realtime.crossfire.jxclient.shortcuts.Shortcuts.Shortcuts	(	@NotNull final CommandQueue	commandQueue,
		@NotNull final SpellsManager	spellsManager
	)

Creates a new instance.

Parameters:

	commandQueue	the command queue for executing commands
	spellsManager	the instance to watch

Definition at line 83 of file Shortcuts.java.

---

Member Function Documentation

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.addShortcutsListener

(

@NotNull final ShortcutsListener

listener

)

Adds a ShortcutsListener.

Parameters:

listener

the listener to add

Definition at line 217 of file Shortcuts.java.

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.clearShortcuts

(

)

Clears all defined shortcuts.

Definition at line 91 of file Shortcuts.java.

Here is the call graph for this function:

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.executeShortcut

(

final int

index

)

Executes a shortcut. Does nothing if the shortcut is unset.

Parameters:

index

the shortcut index

Definition at line 206 of file Shortcuts.java.

Here is the call graph for this function:

File com.realtime.crossfire.jxclient.shortcuts.Shortcuts.getFile

(

)

Returns the backing file.

Returns:

the backing file or null if unknown

Definition at line 250 of file Shortcuts.java.

boolean com.realtime.crossfire.jxclient.shortcuts.Shortcuts.isModified

(

)

Returns whether the shortcuts have been modified since creation or last call to resetModified().

Returns:

whether anything was modified

Definition at line 234 of file Shortcuts.java.

Iterator<Shortcut> com.realtime.crossfire.jxclient.shortcuts.Shortcuts.iterator

(

)

Definition at line 266 of file Shortcuts.java.

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.removeShortcutsListener

(

@NotNull final ShortcutsListener

listener

)

Removes a ShortcutsListener.

Parameters:

listener

the listener to remove

Definition at line 225 of file Shortcuts.java.

Here is the caller graph for this function:

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.resetModified

(

)

Resets the modified state.

Definition at line 241 of file Shortcuts.java.

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.setCommandShortcut	(	final int	index,
		@NotNull final String	command
	)

Sets a Shortcut to a command.

Parameters:

	index	the shortcut index
	command	the command to execute

Definition at line 187 of file Shortcuts.java.

Here is the call graph for this function:

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.setFile

(

@Nullable final File

file

)

Sets the backing file.

Parameters:

file

the backing file or null if unknown

Definition at line 258 of file Shortcuts.java.

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.setShortcut	(	final int	index,
		@Nullable final Shortcut	shortcut
	)

Sets a Shortcut.

Parameters:

	index	the shortcut index
	shortcut	the shortcut to set or null to unset

Definition at line 128 of file Shortcuts.java.

Here is the call graph for this function:

Here is the caller graph for this function:

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.setSpellShortcut	(	final int	index,
		@NotNull final Spell	spell,
		final boolean	cast
	)

Sets a Shortcut to a spell.

Parameters:

	index	the shortcut index
	spell	the spell to cast or invoke
	cast	whether the spell should be cast (true) or invoked (false)

Definition at line 176 of file Shortcuts.java.

Here is the call graph for this function:

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.setSpellShortcut	(	final int	index,
		@NotNull final String	spellName,
		final boolean	cast
	)

Sets a Shortcut to a spell.

Parameters:

	index	the shortcut index
	spellName	the spell name to cast or invoke
	cast	whether the spell should be cast (true) or invoked (false)

Definition at line 164 of file Shortcuts.java.

Here is the call graph for this function:

Here is the caller graph for this function:

void com.realtime.crossfire.jxclient.shortcuts.Shortcuts.unsetShortcut

(

final int

index

)

Unsets a Shortcut.

Parameters:

index

the shortcut index

Definition at line 153 of file Shortcuts.java.

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• /home/leaf/crossfire/jxclient/trunk/gui/src/main/java/com/realtime/crossfire/jxclient/shortcuts/Shortcuts.java