Crossfire JXClient, Trunk
JXCSkin.java
Go to the documentation of this file.
1 /*
2  * This file is part of JXClient, the Fullscreen Java Crossfire Client.
3  *
4  * JXClient is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * JXClient is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with JXClient; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17  *
18  * Copyright (C) 2005-2008 Yann Chachkoff
19  * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
20  * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
21  */
22 
23 package com.realtime.crossfire.jxclient.skin.skin;
24 
31 import java.util.Collection;
32 import java.util.Iterator;
33 import org.jetbrains.annotations.NotNull;
34 import org.jetbrains.annotations.Nullable;
35 
42 public interface JXCSkin extends Iterable<Gui> {
43 
49  @NotNull
50  String getSkinName();
51 
56  @NotNull
58 
63  @NotNull
65 
71  @NotNull
72  @Override
73  Iterator<Gui> iterator();
74 
80  @Nullable
82 
88  @Nullable
90 
96  @Nullable
98 
103  @NotNull
105 
110  @NotNull
112 
118  @NotNull
119  Gui getDialogBook(int bookNo);
120 
125  @NotNull
127 
132  @NotNull
134 
139  @NotNull
141 
148  @NotNull
149  Gui getDialog(@NotNull final String name) throws JXCSkinException;
150 
157  @NotNull
158  CommandList getCommandList(@NotNull String name) throws JXCSkinException;
159 
164  @NotNull
165  Collection<String> getCommandListNames();
166 
171  @NotNull
173 
178  void attach(@NotNull TooltipManagerImpl tooltipManager);
179 
183  void detach();
184 
189  @Nullable
191 
192 }
com.realtime.crossfire.jxclient
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getCommandList
CommandList getCommandList(@NotNull String name)
Returns a named command list.
com.realtime.crossfire.jxclient.gui.gui.Gui
Combines a list of GUIElements to for a gui.
Definition: Gui.java:49
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDialogKeyBind
Gui getDialogKeyBind()
Returns the key bindings dialog.
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getMainInterface
Gui getMainInterface()
Returns the main window.
com.realtime.crossfire.jxclient.gui.label
Definition: AbstractLabel.java:23
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDefaultKeyBindings
KeyBindings getDefaultKeyBindings()
Returns the default key bindings for this skin.
com.realtime.crossfire.jxclient.gui.label.AbstractLabel
Abstract base class for all label classes.
Definition: AbstractLabel.java:43
com.realtime.crossfire.jxclient.gui.commandlist
Definition: CommandList.java:23
com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl
Manages the tooltip display.
Definition: TooltipManagerImpl.java:38
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDialogConnect
Gui getDialogConnect()
Returns the "connection in progress" dialog.
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDialogQuit
Gui getDialogQuit()
Returns the "really quit?" dialog.
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getMaxResolution
Resolution getMaxResolution()
Returns the maximal resolution of this skin.
com.realtime.crossfire.jxclient.gui.keybindings
Definition: InvalidKeyBindingException.java:23
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getStartInterface
Gui getStartInterface()
Returns the start window.
com.realtime.crossfire.jxclient.skin.skin.JXCSkinException
Exception thrown if a skin related problem occurs.
Definition: JXCSkinException.java:31
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.iterator
Iterator< Gui > iterator()
Returns all gui instances of this skin.
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getMetaInterface
Gui getMetaInterface()
Returns the server selection window.
com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings
Manages a set of key bindings.
Definition: KeyBindings.java:47
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.detach
void detach()
Frees all allocated resources.
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDialog
Gui getDialog(@NotNull final String name)
Returns a dialog by name.
com.realtime.crossfire.jxclient.gui
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.attach
void attach(@NotNull TooltipManagerImpl tooltipManager)
Attaches this skin to a gui manager.
com.realtime.crossfire.jxclient.util.Resolution
Information about JXClient's screen/window resolution.
Definition: Resolution.java:36
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getSkinName
String getSkinName()
Returns a short name for the skin.
com.realtime.crossfire.jxclient.util
Definition: Codec.java:23
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDialogQuery
Gui getDialogQuery()
Returns the dialog for query text input.
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getCommandListNames
Collection< String > getCommandListNames()
Returns the names of all named command lists.
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDialogBook
Gui getDialogBook(int bookNo)
Returns the popup dialog for readables.
com.realtime.crossfire.jxclient.gui.commandlist.CommandList
A list of GUICommand instances.
Definition: CommandList.java:34
com.realtime.crossfire.jxclient.gui.gui
Definition: AbstractGUIElement.java:23
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getDialogDisconnect
Gui getDialogDisconnect()
Returns the "disconnect from server?" dialog.
com.realtime.crossfire
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getTooltipLabel
AbstractLabel getTooltipLabel()
Returns the AbstractLabel that is used to display tooltips.
com.realtime
com.realtime.crossfire.jxclient.skin.skin.JXCSkin
Defines a JXClient skin consisting of a main Gui and zero or more dialog Guis.
Definition: JXCSkin.java:42
com
com.realtime.crossfire.jxclient.skin.skin.JXCSkin.getMinResolution
Resolution getMinResolution()
Returns the minimal resolution of this skin.