com.realtime.crossfire.jxclient.skin.factory.DialogFactory Class Reference

A factory class to create "textbutton" instances. More...

Collaboration diagram for com.realtime.crossfire.jxclient.skin.factory.DialogFactory:

Public Member Functions
	DialogFactory (@NotNull final Image frameNW, @NotNull final Image frameN, @NotNull final Image frameNE, @NotNull final Image frameW, @NotNull final Image frameC, @NotNull final Image frameE, @NotNull final Image frameSW, @NotNull final Image frameS, @NotNull final Image frameSE, @NotNull final Font titleFont, @NotNull final Color titleColor, @NotNull final Color titleBackgroundColor, final float frameAlpha, @NotNull final GuiFactory guiFactory)
	Creates a new instance. More...
float	getFrameAlpha ()
	Returns the alpha value for the frame background. More...
Iterable< AbstractGUIElement >	newDialog (@NotNull final TooltipManager tooltipManager, @NotNull final JXCWindowRenderer windowRenderer, @NotNull final GUIElementListener elementListener, @NotNull final String title)
	Creates a new dialog. More...

Private Attributes
final float	frameAlpha
	The alpha transparency for the dialog background, 1 is opaque and 0 is transparent. More...
final Image	frameC
	The center frame picture. More...
final Image	frameE
	The east frame picture. More...
final Image	frameN
	The north frame picture. More...
final Image	frameNE
	The north-east frame picture. More...
final Image	frameNW
	The north-west frame picture. More...
final Image	frameS
	The south frame picture. More...
final Image	frameSE
	The south-east frame picture. More...
final Image	frameSW
	The south-west frame picture. More...
final Image	frameW
	The west frame picture. More...
final GuiFactory	guiFactory
	The global GuiFactory instance. More...
final Color	titleBackgroundColor
	The background color for the dialog title. More...
final Color	titleColor
	The color for the dialog title. More...
final Font	titleFont
	The font for the dialog title. More...

Detailed Description

A factory class to create "textbutton" instances.

Author

Andreas Kirschbaum

Definition at line 44 of file DialogFactory.java.

Constructor & Destructor Documentation

DialogFactory()

com.realtime.crossfire.jxclient.skin.factory.DialogFactory.DialogFactory	(	@NotNull final Image	frameNW,
		@NotNull final Image	frameN,
		@NotNull final Image	frameNE,
		@NotNull final Image	frameW,
		@NotNull final Image	frameC,
		@NotNull final Image	frameE,
		@NotNull final Image	frameSW,
		@NotNull final Image	frameS,
		@NotNull final Image	frameSE,
		@NotNull final Font	titleFont,
		@NotNull final Color	titleColor,
		@NotNull final Color	titleBackgroundColor,
		final float	frameAlpha,
		@NotNull final GuiFactory	guiFactory
	)

Creates a new instance.

The border images must have matching sizes.

Parameters

frameNW	the north-west frame picture
frameN	the north frame picture
frameNE	the north-east frame picture
frameW	the west frame picture
frameC	the center frame picture
frameE	the east frame picture
frameSW	the south-west frame picture
frameS	the south frame picture
frameSE	the south-east frame picture
titleFont	the font for the dialog title
titleColor	the color for the dialog title
titleBackgroundColor	the background color for the dialog title
frameAlpha	the alpha value for the dialog background except for the title
guiFactory	the global GUI factory instance

Definition at line 146 of file DialogFactory.java.

References com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameAlpha, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameC, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameE, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameN, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameNE, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameNW, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameS, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameSE, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameSW, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameW, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.guiFactory, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.titleBackgroundColor, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.titleColor, and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.titleFont.

Member Function Documentation

getFrameAlpha()

float com.realtime.crossfire.jxclient.skin.factory.DialogFactory.getFrameAlpha

(

)

Returns the alpha value for the frame background.

Returns

alpha value, 1 is opaque and 0 totally transparent

Definition at line 233 of file DialogFactory.java.

References com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameAlpha.

Referenced by com.realtime.crossfire.jxclient.skin.io.JXCSkinLoader.parseGauge(), and com.realtime.crossfire.jxclient.skin.io.JXCSkinLoader.parseTextGauge().

Here is the caller graph for this function:

newDialog()

Iterable<AbstractGUIElement> com.realtime.crossfire.jxclient.skin.factory.DialogFactory.newDialog	(	@NotNull final TooltipManager	tooltipManager,
		@NotNull final JXCWindowRenderer	windowRenderer,
		@NotNull final GUIElementListener	elementListener,
		@NotNull final String	title
	)

Creates a new dialog.

Parameters

tooltipManager	the tooltip manager to update
windowRenderer	the window renderer the dialog belongs to
elementListener	the element listener to notify
title	the dialog's title, or an empty string for no title

Returns

the newly created GUI elements

Definition at line 218 of file DialogFactory.java.

References com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameAlpha, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameC, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameE, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameN, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameNE, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameNW, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameS, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameSE, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameSW, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameW, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.guiFactory, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.titleBackgroundColor, com.realtime.crossfire.jxclient.skin.factory.DialogFactory.titleColor, and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.titleFont.

Referenced by com.realtime.crossfire.jxclient.skin.io.JXCSkinLoader.parseDialog().

Here is the caller graph for this function:

Member Data Documentation

frameAlpha

final float com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameAlpha

private

The alpha transparency for the dialog background, 1 is opaque and 0 is transparent.

Definition at line 120 of file DialogFactory.java.

Referenced by com.realtime.crossfire.jxclient.skin.factory.DialogFactory.DialogFactory(), com.realtime.crossfire.jxclient.skin.factory.DialogFactory.getFrameAlpha(), and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.newDialog().

frameC

final Image com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameC

private

The center frame picture.

Definition at line 74 of file DialogFactory.java.

Referenced by com.realtime.crossfire.jxclient.skin.factory.DialogFactory.DialogFactory(), and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.newDialog().

frameE

final Image com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameE

private

The east frame picture.

Definition at line 80 of file DialogFactory.java.

Referenced by com.realtime.crossfire.jxclient.skin.factory.DialogFactory.DialogFactory(), and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.newDialog().

frameN

final Image com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameN

private

The north frame picture.

Definition at line 56 of file DialogFactory.java.

Referenced by com.realtime.crossfire.jxclient.skin.factory.DialogFactory.DialogFactory(), and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.newDialog().

frameNE

final Image com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameNE

private

The north-east frame picture.

Definition at line 62 of file DialogFactory.java.

Referenced by com.realtime.crossfire.jxclient.skin.factory.DialogFactory.DialogFactory(), and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.newDialog().

frameNW

final Image com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameNW

private

The north-west frame picture.

Definition at line 50 of file DialogFactory.java.

Referenced by com.realtime.crossfire.jxclient.skin.factory.DialogFactory.DialogFactory(), and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.newDialog().

frameS

final Image com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameS

private

The south frame picture.

Definition at line 92 of file DialogFactory.java.

Referenced by com.realtime.crossfire.jxclient.skin.factory.DialogFactory.DialogFactory(), and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.newDialog().

frameSE

final Image com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameSE

private

The south-east frame picture.

Definition at line 98 of file DialogFactory.java.

Referenced by com.realtime.crossfire.jxclient.skin.factory.DialogFactory.DialogFactory(), and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.newDialog().

frameSW

final Image com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameSW

private

The south-west frame picture.

Definition at line 86 of file DialogFactory.java.

Referenced by com.realtime.crossfire.jxclient.skin.factory.DialogFactory.DialogFactory(), and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.newDialog().

frameW

final Image com.realtime.crossfire.jxclient.skin.factory.DialogFactory.frameW

private

The west frame picture.

Definition at line 68 of file DialogFactory.java.

Referenced by com.realtime.crossfire.jxclient.skin.factory.DialogFactory.DialogFactory(), and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.newDialog().

guiFactory

final GuiFactory com.realtime.crossfire.jxclient.skin.factory.DialogFactory.guiFactory

private

The global GuiFactory instance.

Definition at line 126 of file DialogFactory.java.

Referenced by com.realtime.crossfire.jxclient.skin.factory.DialogFactory.DialogFactory(), and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.newDialog().

titleBackgroundColor

final Color com.realtime.crossfire.jxclient.skin.factory.DialogFactory.titleBackgroundColor

private

The background color for the dialog title.

Definition at line 114 of file DialogFactory.java.

Referenced by com.realtime.crossfire.jxclient.skin.factory.DialogFactory.DialogFactory(), and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.newDialog().

titleColor

final Color com.realtime.crossfire.jxclient.skin.factory.DialogFactory.titleColor

private

The color for the dialog title.

Definition at line 108 of file DialogFactory.java.

Referenced by com.realtime.crossfire.jxclient.skin.factory.DialogFactory.DialogFactory(), and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.newDialog().

titleFont

final Font com.realtime.crossfire.jxclient.skin.factory.DialogFactory.titleFont

private

The font for the dialog title.

Definition at line 103 of file DialogFactory.java.

Referenced by com.realtime.crossfire.jxclient.skin.factory.DialogFactory.DialogFactory(), and com.realtime.crossfire.jxclient.skin.factory.DialogFactory.newDialog().

---

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

• src/gui/src/main/java/com/realtime/crossfire/jxclient/skin/factory/DialogFactory.java