com.realtime.crossfire.jxclient.skin.skin

Interface JXCSkin

All Superinterfaces:

java.lang.Iterable<Gui>

All Known Implementing Classes:

DefaultJXCSkin

public interface JXCSkin
extends java.lang.Iterable<Gui>

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

Method Summary

Modifier and Type	Method and Description
void	attach(@NotNull TooltipManagerImpl tooltipManager) Attaches this skin to a gui manager.
void	detach() Frees all allocated resources.
@NotNull CommandList	getCommandList(@NotNull java.lang.String name) Returns a named command list.
@NotNull java.util.Collection<java.lang.String>	getCommandListNames() Returns the names of all named command lists.
@NotNull KeyBindings	getDefaultKeyBindings() Returns the default key bindings for this skin.
@NotNull Gui	getDialog(@NotNull java.lang.String name) Returns a dialog by name.
@NotNull Gui	getDialogBook(int bookNo) Returns the popup dialog for readables.
@Nullable Gui	getDialogConnect() Returns the "connection in progress" dialog.
@Nullable Gui	getDialogDisconnect() Returns the "disconnect from server?" dialog.
@NotNull Gui	getDialogKeyBind() Returns the key bindings dialog.
@NotNull Gui	getDialogQuery() Returns the dialog for query text input.
@Nullable Gui	getDialogQuit() Returns the "really quit?" dialog.
@NotNull Gui	getMainInterface() Returns the main window.
@NotNull Resolution	getMaxResolution() Returns the maximal resolution of this skin.
@NotNull Gui	getMetaInterface() Returns the server selection window.
@NotNull Resolution	getMinResolution() Returns the minimal resolution of this skin.
@NotNull java.lang.String	getSkinName() Returns a short name for the skin.
@NotNull Gui	getStartInterface() Returns the start window.
@Nullable AbstractLabel	getTooltipLabel() Returns the AbstractLabel that is used to display tooltips.
@NotNull java.util.Iterator<Gui>	iterator() Returns all gui instances of this skin.
void	setScreenSize(int screenWidth, int screenHeight) Updates the skin's gui elements to a screen size.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getSkinName

@NotNull
@NotNull java.lang.String getSkinName()

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

Returns:

the skin name

getMinResolution

@NotNull
@NotNull Resolution getMinResolution()

Returns the minimal resolution of this skin.

Returns:

the minimal resolution

getMaxResolution

@NotNull
@NotNull Resolution getMaxResolution()

Returns the maximal resolution of this skin.

Returns:

the maximal resolution

iterator

@NotNull
@NotNull java.util.Iterator<Gui> iterator()

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

Specified by:

iterator in interface java.lang.Iterable<Gui>

Returns:

an iterator returning all gui instances

getDialogQuit

@Nullable
@Nullable Gui 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

getDialogDisconnect

@Nullable
@Nullable Gui 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

getDialogConnect

@Nullable
@Nullable Gui 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

getDialogKeyBind

@NotNull
@NotNull Gui getDialogKeyBind()

Returns the key bindings dialog.

Returns:

the dialog

getDialogQuery

@NotNull
@NotNull Gui getDialogQuery()

Returns the dialog for query text input.

Returns:

the dialog

getDialogBook

@NotNull
@NotNull Gui getDialogBook(int bookNo)

Returns the popup dialog for readables.

Parameters:

bookNo - the book ID

Returns:

the dialog

getMainInterface

@NotNull
@NotNull Gui getMainInterface()

Returns the main window.

Returns:

the dialog

getMetaInterface

@NotNull
@NotNull Gui getMetaInterface()

Returns the server selection window.

Returns:

the dialog

getStartInterface

@NotNull
@NotNull Gui getStartInterface()

Returns the start window.

Returns:

the dialog

getDialog

@NotNull
@NotNull Gui getDialog(@NotNull
                                @NotNull java.lang.String name)
                         throws JXCSkinException

Returns a dialog by name.

Parameters:

name - the dialog's name

Returns:

the dialog

Throws:

JXCSkinException - if the dialog does not exist

getCommandList

@NotNull
@NotNull CommandList getCommandList(@NotNull
                                             @NotNull java.lang.String name)
                                      throws JXCSkinException

Returns a named command list.

Parameters:

name - the name of the command list

Returns:

the command list

Throws:

JXCSkinException - if the command list does not exist

getCommandListNames

@NotNull
@NotNull java.util.Collection<java.lang.String> getCommandListNames()

Returns the names of all named command lists.

Returns:

the names in alphabetical order

getDefaultKeyBindings

@NotNull
@NotNull KeyBindings getDefaultKeyBindings()

Returns the default key bindings for this skin.

Returns:

the default key bindings

attach

void attach(@NotNull
            @NotNull TooltipManagerImpl tooltipManager)

Attaches this skin to a gui manager.

Parameters:

tooltipManager - the tooltip manager to attach to

detach

void detach()

Frees all allocated resources.

setScreenSize

void setScreenSize(int screenWidth,
                   int screenHeight)

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

Parameters:

screenWidth - the new screen width

screenHeight - the new screen height

getTooltipLabel

@Nullable
@Nullable AbstractLabel getTooltipLabel()

Returns the AbstractLabel that is used to display tooltips.

Returns:

the label or null if tooltips are disabled