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

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

Public Member Functions
void	attach (@NotNull TooltipManagerImpl tooltipManager)

void	detach ()

CommandList	getCommandList (@NotNull String name) throws JXCSkinException

Collection< String >	getCommandListNames ()

KeyBindings	getDefaultKeyBindings ()

Gui	getDialog (@NotNull final String name) throws JXCSkinException

Gui	getDialogBook (int bookNo)

Gui	getDialogConnect ()

Gui	getDialogDisconnect ()

Gui	getDialogKeyBind ()

Gui	getDialogQuery ()

Gui	getDialogQuit ()

Gui	getMainInterface ()

Resolution	getMaxResolution ()

Gui	getMetaInterface ()

Resolution	getMinResolution ()

String	getSkinName ()

Gui	getStartInterface ()

AbstractLabel	getTooltipLabel ()

Iterator< Gui >	iterator ()

void	setScreenSize (final int screenWidth, final int screenHeight)

Detailed Description

Defines a JXClient skin consisting of a main Gui and zero or more dialog Guis.

Author: Lauwenmark; Andreas Kirschbaum

Definition at line 42 of file JXCSkin.java.

Member Function Documentation

◆ attach()

void com.realtime.crossfire.jxclient.skin.skin.JXCSkin.attach ( @NotNull TooltipManagerImpl tooltipManager )

Attaches this skin to a gui manager.

Parameters

tooltipManager the tooltip manager to attach to

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.setSkin().

Here is the caller graph for this function:

◆ detach()

void com.realtime.crossfire.jxclient.skin.skin.JXCSkin.detach ( )

Frees all allocated resources.

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.unsetSkin().

Here is the caller graph for this function:

◆ getCommandList()

CommandList com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getCommandList ( @NotNull String name ) throws JXCSkinException

Returns a named command list.

Parameters

name	the name of the command list

Returns: the command list

Exceptions

JXCSkinException if the command list does not exist

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.getCommandList().

Here is the caller graph for this function:

◆ getCommandListNames()

Collection<String> com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getCommandListNames ( )

Returns the names of all named command lists.

Returns: the names in alphabetical order

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.getCommandListNames().

Here is the caller graph for this function:

◆ getDefaultKeyBindings()

KeyBindings com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDefaultKeyBindings ( )

Returns the default key bindings for this skin.

Returns: the default key bindings

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

◆ getDialog()

Gui com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDialog ( @NotNull final String name ) throws JXCSkinException

Returns a dialog by name.

Parameters

name	the dialog's name

Returns: the dialog

Exceptions

JXCSkinException if the dialog does not exist

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.closeDialogByName(), and com.realtime.crossfire.jxclient.window.GuiManager.openDialogByName().

Here is the caller graph for this function:

◆ getDialogBook()

Gui com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDialogBook ( int bookNo )

Returns the popup dialog for readables.

Parameters

bookNo the book ID

Returns: the dialog

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.closeTransientDialogs(), and com.realtime.crossfire.jxclient.window.GuiManager.escPressed().

Here is the caller graph for this function:

◆ getDialogConnect()

Gui com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDialogConnect ( )

Returns the "connection in progress" dialog. It is opened while the connection establishment is in progress.

Returns: the dialog or
null

if the dialog does not exist

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.setSkin().

Here is the caller graph for this function:

◆ getDialogDisconnect()

Gui com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDialogDisconnect ( )

Returns the "disconnect from server?" dialog. It is opened when the user presses ESCAPE.

Returns: the dialog or
null

if the dialog does not exist

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.setSkin().

Here is the caller graph for this function:

◆ getDialogKeyBind()

Gui com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDialogKeyBind ( )

Returns the key bindings dialog.

Returns: the dialog

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.setSkin().

Here is the caller graph for this function:

◆ getDialogQuery()

Gui com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDialogQuery ( )

Returns the dialog for query text input.

Returns: the dialog

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.setSkin().

Here is the caller graph for this function:

◆ getDialogQuit()

Gui com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDialogQuit ( )

Returns the "really quit?" dialog. It is opened when the user presses ESCAPE.

Returns: the dialog or
null

if the dialog does not exist

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.setSkin().

Here is the caller graph for this function:

◆ getMainInterface()

Gui com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getMainInterface ( )

Returns the main window.

Returns: the dialog

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.showGUIMain().

Here is the caller graph for this function:

◆ getMaxResolution()

Resolution com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getMaxResolution ( )

Returns the maximal resolution of this skin.

Returns: the maximal resolution

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.main.SkinLoader.loadSkin().

Here is the caller graph for this function:

◆ getMetaInterface()

Gui com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getMetaInterface ( )

Returns the server selection window.

Returns: the dialog

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.showGUIMeta().

Here is the caller graph for this function:

◆ getMinResolution()

Resolution com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getMinResolution ( )

Returns the minimal resolution of this skin.

Returns: the minimal resolution

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.main.SkinLoader.loadSkin().

Here is the caller graph for this function:

◆ getSkinName()

String com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getSkinName ( )

Returns a short name for the skin. It is used to construct path or file names.

Returns: the skin name

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

◆ getStartInterface()

Gui com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getStartInterface ( )

Returns the start window.

Returns: the dialog

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.showGUIStart().

Here is the caller graph for this function:

◆ getTooltipLabel()

AbstractLabel com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getTooltipLabel ( )

Returns the AbstractLabel that is used to display tooltips.

Returns: the label or
null

if tooltips are disabled

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.setSkin().

Here is the caller graph for this function:

◆ iterator()

Iterator<Gui> com.realtime.crossfire.jxclient.skin.skin.JXCSkin.iterator ( )

Returns all gui instances of this skin. The instances have no defined order.

Returns: an iterator returning all gui instances

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

◆ setScreenSize()

void com.realtime.crossfire.jxclient.skin.skin.JXCSkin.setScreenSize	(	final int	screenWidth,
		final int	screenHeight
	)

Updates the skin's gui elements to a screen size.

Parameters

screenWidth	the new screen width
screenHeight	the new screen height

Implemented in com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.updateWindowSize().

Here is the caller graph for this function:

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

src/gui/src/main/java/com/realtime/crossfire/jxclient/skin/skin/JXCSkin.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ attach()

◆ detach()

◆ getCommandList()

◆ getCommandListNames()

◆ getDefaultKeyBindings()

◆ getDialog()

◆ getDialogBook()

◆ getDialogConnect()

◆ getDialogDisconnect()

◆ getDialogKeyBind()

◆ getDialogQuery()

◆ getDialogQuit()

◆ getMainInterface()

◆ getMaxResolution()

◆ getMetaInterface()

◆ getMinResolution()

◆ getSkinName()

◆ getStartInterface()

◆ getTooltipLabel()

◆ iterator()

◆ setScreenSize()