com.realtime.crossfire.jxclient.skin.skin.Dialogs Class Reference

Maintains a set of Gui instances representing dialog windows. More...

Inheritance diagram for com.realtime.crossfire.jxclient.skin.skin.Dialogs:

Collaboration diagram for com.realtime.crossfire.jxclient.skin.skin.Dialogs:

Public Member Functions
void	addDialog (@NotNull final String name)
	Creates a new dialog instance. More...
	Dialogs (@NotNull final GuiFactory guiFactory, @NotNull final GuiManager guiManager)
	Creates a new instance. More...
String	getDialogToLoad ()
	Returns one dialog pending loading. More...
Iterator< Gui >	iterator ()
Gui	lookup (@NotNull final String name) throws JXCSkinException
	Returns a dialog instance by dialog name. More...

Private Attributes
final JXCSkinCache< Gui >	dialogs = new JXCSkinCache<>("dialog")
	The existing dialogs. More...
final Collection< String >	dialogsToLoad = new HashSet<>()
	Names of pending skin files. More...
final GuiFactory	guiFactory
	The GuiFactory for creating new Gui instances. More...
final GuiManager	guiManager
	The GuiManager to add dialogs to. More...

Detailed Description

Maintains a set of Gui instances representing dialog windows.

These dialogs can be looked up by name. Also maintains a set of dialogs pending loading.

Author

Andreas Kirschbaum

Definition at line 39 of file Dialogs.java.

Constructor & Destructor Documentation

Dialogs()

com.realtime.crossfire.jxclient.skin.skin.Dialogs.Dialogs	(	@NotNull final GuiFactory	guiFactory,
		@NotNull final GuiManager	guiManager
	)

Creates a new instance.

Parameters

guiFactory	the gui factory for creating gui instances
guiManager	the GUI manager to add dialogs to

Definition at line 70 of file Dialogs.java.

References com.realtime.crossfire.jxclient.skin.skin.Dialogs.guiFactory, and com.realtime.crossfire.jxclient.skin.skin.Dialogs.guiManager.

Member Function Documentation

addDialog()

void com.realtime.crossfire.jxclient.skin.skin.Dialogs.addDialog

(

@NotNull final String

name

)

Creates a new dialog instance.

Parameters

name	the dialog's name

Definition at line 90 of file Dialogs.java.

References com.realtime.crossfire.jxclient.window.GuiManager.addDialog(), com.realtime.crossfire.jxclient.skin.skin.Dialogs.dialogs, com.realtime.crossfire.jxclient.skin.skin.Dialogs.dialogsToLoad, com.realtime.crossfire.jxclient.skin.skin.Dialogs.guiFactory, com.realtime.crossfire.jxclient.skin.skin.Dialogs.guiManager, and com.realtime.crossfire.jxclient.skin.skin.GuiFactory.newGui().

Referenced by com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.addDialog(), com.realtime.crossfire.jxclient.skin.io.CommandParser.parseDialogClose(), com.realtime.crossfire.jxclient.skin.io.CommandParser.parseDialogOpen(), and com.realtime.crossfire.jxclient.skin.io.CommandParser.parseDialogToggle().

Here is the call graph for this function:

Here is the caller graph for this function:

getDialogToLoad()

String com.realtime.crossfire.jxclient.skin.skin.Dialogs.getDialogToLoad

(

)

Returns one dialog pending loading.

Each dialog is returned only once.

Returns

a dialog pending loading or

null 

Definition at line 110 of file Dialogs.java.

References com.realtime.crossfire.jxclient.skin.skin.Dialogs.dialogsToLoad.

Referenced by com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.getDialogToLoad().

Here is the caller graph for this function:

iterator()

Iterator<Gui> com.realtime.crossfire.jxclient.skin.skin.Dialogs.iterator

(

)

Definition at line 123 of file Dialogs.java.

References com.realtime.crossfire.jxclient.skin.skin.Dialogs.dialogs.

Referenced by com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.iterator().

Here is the caller graph for this function:

lookup()

Gui com.realtime.crossfire.jxclient.skin.skin.Dialogs.lookup

(

@NotNull final String

name

)

throws JXCSkinException

Returns a dialog instance by dialog name.

Parameters

name	the dialog name

Returns

the dialog instance

Exceptions

JXCSkinException

if the dialog does not exist

Definition at line 82 of file Dialogs.java.

References com.realtime.crossfire.jxclient.skin.skin.Dialogs.dialogs.

Referenced by com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.getDialog().

Here is the caller graph for this function:

Member Data Documentation

dialogs

final JXCSkinCache<Gui> com.realtime.crossfire.jxclient.skin.skin.Dialogs.dialogs = new JXCSkinCache<>("dialog")

private

The existing dialogs.

Definition at line 57 of file Dialogs.java.

Referenced by com.realtime.crossfire.jxclient.skin.skin.Dialogs.addDialog(), com.realtime.crossfire.jxclient.skin.skin.Dialogs.iterator(), and com.realtime.crossfire.jxclient.skin.skin.Dialogs.lookup().

dialogsToLoad

final Collection<String> com.realtime.crossfire.jxclient.skin.skin.Dialogs.dialogsToLoad = new HashSet<>()

private

Names of pending skin files.

Definition at line 63 of file Dialogs.java.

Referenced by com.realtime.crossfire.jxclient.skin.skin.Dialogs.addDialog(), and com.realtime.crossfire.jxclient.skin.skin.Dialogs.getDialogToLoad().

guiFactory

final GuiFactory com.realtime.crossfire.jxclient.skin.skin.Dialogs.guiFactory

private

The GuiFactory for creating new Gui instances.

Definition at line 45 of file Dialogs.java.

Referenced by com.realtime.crossfire.jxclient.skin.skin.Dialogs.addDialog(), and com.realtime.crossfire.jxclient.skin.skin.Dialogs.Dialogs().

guiManager

final GuiManager com.realtime.crossfire.jxclient.skin.skin.Dialogs.guiManager

private

The GuiManager to add dialogs to.

Definition at line 51 of file Dialogs.java.

Referenced by com.realtime.crossfire.jxclient.skin.skin.Dialogs.addDialog(), and com.realtime.crossfire.jxclient.skin.skin.Dialogs.Dialogs().

---

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

• src/gui/src/main/java/com/realtime/crossfire/jxclient/skin/skin/Dialogs.java