Package net.sf.freecol.client.gui

FreeCol Client GUI package

Contains the graphical user interface (GUI) classes.

A JFrame is created during the startup of the program. This frame will be a FreeColFrame which handles both windowed and full screen presentations.

A Canvas will then be added to the frame.

Canvas is the main container for the other GUI components in FreeCol. This class is where the panels, dialogs and menus are added. In addition, Canvas is the component in which the map graphics are displayed.

Other important classes:

• The GUI contains the methods to draw the map upon Canvas, in addition to other useful GUI methods.
• The FreeColMenuBar is the menu bar that is displayed on top corner of the Canvas.

Since:

0.2.0

Interface Summary

Interface	Description
DialogHandler<T>	The interface for non-modal dialog handlers.

Class Summary

Class	Description
AbstractCanvasListener	The outline of a canvas listener.
Canvas	The main container for the other GUI components in FreeCol.
Canvas.ToolBoxFrame	A class for frames being used as tool boxes.
CanvasMapEditorMouseListener	Listens to the mouse being moved at the level of the Canvas.
CanvasMouseListener	Listens to mouse buttons being pressed at the level of the Canvas.
CanvasMouseMotionListener	Listens to the mouse being moved at the level of the Canvas.
ChoiceItem<T>	Can be used as a single choice for the FreeColChoiceDialog.
FontLibrary	Wraps anything Font related.
FrameMotionListener	The mouse adapter to handle frame movement.
FreeColFrame	The base frame for FreeCol.
FullScreenFrameListener	The WindowListener for the FullScreenFrame class.
GrayLayer	Custom component to paint turn progress.
GUI	The API and common reusable functionality for the overall GUI.
ImageLibrary	Holds various images that can be called upon by others in order to display certain things.
LoadingSavegameInfo	Used for transferring data for the savegame to be loaded.
ModifierFormat
ScrollThread	Scrolls the view of the Map by moving its focus.
SplashScreen	Class to contain the splash screen.
SwingGUI	A wrapper providing functionality for the overall GUI using Java Swing.
TilePopup	Allows the user to obtain more info about a certain tile or to activate a specific unit on the tile, or perform various debug mode actions.
Widgets	Container for all the higher level dialogs and panels.
WindowedFrameListener	The WindowListener for the WindowedFrame class.

Enum Summary

Enum	Description
FontLibrary.FontType	FontType is used for choosing the typeface of the Font.
GUI.ViewMode	View modes.
ImageLibrary.PathType	Helper to distinguish different types of paths.
Size	Standard sizes.
SwingGUI.PopupPosition	A rough position to place dialogs and panels on the canvas.