Crossfire JXClient, Trunk  R20561
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-2011 Andreas Kirschbaum.
20  */
21 
22 package com.realtime.crossfire.jxclient.skin.skin;
23 
30 import java.util.Iterator;
31 import org.jetbrains.annotations.NotNull;
32 import org.jetbrains.annotations.Nullable;
33 
40 public interface JXCSkin extends Iterable<Gui> {
41 
47  @NotNull
48  String getSkinName();
49 
54  @NotNull
56 
61  @NotNull
63 
69  @NotNull
70  @Override
71  @SuppressWarnings("AbstractMethodOverridesAbstractMethod")
72  Iterator<Gui> iterator();
73 
79  @Nullable
81 
87  @Nullable
89 
95  @Nullable
97 
102  @NotNull
104 
109  @NotNull
111 
117  @NotNull
118  Gui getDialogBook(int bookNo);
119 
124  @NotNull
126 
131  @NotNull
133 
138  @NotNull
140 
147  @NotNull
148  Gui getDialog(@NotNull final String name) throws JXCSkinException;
149 
156  @NotNull
157  CommandList getCommandList(@NotNull String name) throws JXCSkinException;
158 
163  @NotNull
165 
170  void attach(@NotNull TooltipManagerImpl tooltipManager);
171 
175  void detach();
176 
182  void setScreenSize(final int screenWidth, final int screenHeight);
183 
188  @Nullable
190 
191 }
CommandList getCommandList(@NotNull String name)
Returns a named command list.
Abstract base class for all label classes.
void setScreenSize(final int screenWidth, final int screenHeight)
Updates the skin&#39;s gui elements to a screen size.
Combines a list of GUIElements to for a gui.
Definition: Gui.java:43
Gui getDialogKeyBind()
Returns the key bindings dialog.
KeyBindings getDefaultKeyBindings()
Returns the default key bindings for this skin.
Gui getMainInterface()
Returns the main window.
Gui getDialogConnect()
Returns the "connection in progress" dialog.
Gui getDialogQuit()
Returns the "really quit?" dialog.
Iterator< Gui > iterator()
Returns all gui instances of this skin.
Resolution getMaxResolution()
Returns the maximal resolution of this skin.
Gui getMetaInterface()
Returns the server selection window.
Gui getStartInterface()
Returns the start window.
void detach()
Frees all allocated resources.
Defines a JXClient skin consisting of a main Gui and zero or more dialog Guis.
Definition: JXCSkin.java:40
Gui getDialog(@NotNull final String name)
Returns a dialog by name.
void attach(@NotNull TooltipManagerImpl tooltipManager)
Attaches this skin to a gui manager.
String getSkinName()
Returns a short name for the skin.
Gui getDialogQuery()
Returns the dialog for query text input.
Gui getDialogBook(int bookNo)
Returns the popup dialog for readables.
Gui getDialogDisconnect()
Returns the "disconnect from server?" dialog.
Exception thrown if a skin related problem occurs.
AbstractLabel getTooltipLabel()
Returns the AbstractLabel that is used to display tooltips.
Information about JXClient&#39;s screen/window resolution.
Definition: Resolution.java:35
Resolution getMinResolution()
Returns the minimal resolution of this skin.