com.realtime.crossfire.jxclient.skin.factory

Class DialogFactory

java.lang.Object

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

public class DialogFactory
extends java.lang.Object

A factory class to create "textbutton" instances.

Field Summary

Fields

Modifier and Type	Field and Description
private float	frameAlpha The alpha transparency for the dialog background, 1 is opaque and 0 is transparent.
private java.awt.Image	frameC The center frame picture.
private java.awt.Image	frameE The east frame picture.
private java.awt.Image	frameN The north frame picture.
private java.awt.Image	frameNE The north-east frame picture.
private java.awt.Image	frameNW The north-west frame picture.
private java.awt.Image	frameS The south frame picture.
private java.awt.Image	frameSE The south-east frame picture.
private java.awt.Image	frameSW The south-west frame picture.
private java.awt.Image	frameW The west frame picture.
private java.awt.Color	titleBackgroundColor The background color for the dialog title.
private java.awt.Color	titleColor The color for the dialog title.
private java.awt.Font	titleFont The font for the dialog title.

Constructor Summary

Constructors

Constructor and Description
DialogFactory(java.awt.Image frameNW, java.awt.Image frameN, java.awt.Image frameNE, java.awt.Image frameW, java.awt.Image frameC, java.awt.Image frameE, java.awt.Image frameSW, java.awt.Image frameS, java.awt.Image frameSE, java.awt.Font titleFont, java.awt.Color titleColor, java.awt.Color titleBackgroundColor, float frameAlpha) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
float	getFrameAlpha() Returns the alpha value for the frame background.
java.lang.Iterable<AbstractGUIElement>	newDialog(TooltipManager tooltipManager, JXCWindowRenderer windowRenderer, GUIElementListener elementListener, java.lang.String title) Creates a new dialog.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

frameAlpha

private final float frameAlpha

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

frameC

@NotNull
private final java.awt.Image frameC

The center frame picture.

frameE

@NotNull
private final java.awt.Image frameE

The east frame picture.

frameN

@NotNull
private final java.awt.Image frameN

The north frame picture.

frameNE

@NotNull
private final java.awt.Image frameNE

The north-east frame picture.

frameNW

@NotNull
private final java.awt.Image frameNW

The north-west frame picture.

frameS

@NotNull
private final java.awt.Image frameS

The south frame picture.

frameSE

@NotNull
private final java.awt.Image frameSE

The south-east frame picture.

frameSW

@NotNull
private final java.awt.Image frameSW

The south-west frame picture.

frameW

@NotNull
private final java.awt.Image frameW

The west frame picture.

titleBackgroundColor

@Nullable
private final java.awt.Color titleBackgroundColor

The background color for the dialog title.

titleColor

private final java.awt.Color titleColor

The color for the dialog title.

titleFont

private final java.awt.Font titleFont

The font for the dialog title.

Constructor Detail

DialogFactory

public DialogFactory(@NotNull
                     java.awt.Image frameNW,
                     @NotNull
                     java.awt.Image frameN,
                     @NotNull
                     java.awt.Image frameNE,
                     @NotNull
                     java.awt.Image frameW,
                     @NotNull
                     java.awt.Image frameC,
                     @NotNull
                     java.awt.Image frameE,
                     @NotNull
                     java.awt.Image frameSW,
                     @NotNull
                     java.awt.Image frameS,
                     @NotNull
                     java.awt.Image frameSE,
                     @NotNull
                     java.awt.Font titleFont,
                     @NotNull
                     java.awt.Color titleColor,
                     @NotNull
                     java.awt.Color titleBackgroundColor,
                     float frameAlpha)

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

Method Detail

getFrameAlpha

public float getFrameAlpha()

Returns the alpha value for the frame background.

Returns:

alpha value, 1 is opaque and 0 totally transparent

newDialog

@NotNull
public java.lang.Iterable<AbstractGUIElement> newDialog(@NotNull
                                                                 TooltipManager tooltipManager,
                                                                 @NotNull
                                                                 JXCWindowRenderer windowRenderer,
                                                                 @NotNull
                                                                 GUIElementListener elementListener,
                                                                 @NotNull
                                                                 java.lang.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