com.realtime.crossfire.jxclient.gui.label.AbstractLabel Class Reference

Inheritance diagram for com.realtime.crossfire.jxclient.gui.label.AbstractLabel:

Collaboration diagram for com.realtime.crossfire.jxclient.gui.label.AbstractLabel:

Public Member Functions
void	paintComponent (@NotNull final Graphics g)
void	setText (@NotNull final String text)
void	setTextHighlight (final boolean textHighlight)
Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement
void	dispose ()
int	getDialogBorderBottom ()
int	getDialogBorderLeft ()
int	getDialogBorderRight ()
int	getDialogBorderTop ()
String	getName ()
abstract TooltipText	getTooltip ()
void	inhibitListeners ()
boolean	isDefault ()
boolean	isIgnore ()
void	mouseClicked (@NotNull final MouseEvent e)
void	mouseDragged (@NotNull final MouseEvent e)
void	mouseEntered (@NotNull final MouseEvent e)
void	mouseExited (@NotNull final MouseEvent e)
void	mouseMoved (@NotNull final MouseEvent e)
void	mousePressed (@NotNull final MouseEvent e)
void	mouseReleased (@NotNull final MouseEvent e)
void	mouseWheelMoved (final int wheelRotation)
void	setChanged ()
void	setChangedListener (@Nullable final GUIElementChangedListener changedListener)
void	setDefault (final boolean isDefault)
void	setIgnore ()
String	toString ()
Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.GUIElement
void	notifyOpen ()

Protected Member Functions
	AbstractLabel (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, @NotNull final String text, @NotNull final Font textFont, @NotNull final Color textColor, @NotNull final Color textHighlightColor, @Nullable final BufferedImage backgroundPicture, @Nullable final Color backgroundColor, @NotNull final GuiFactory guiFactory)
String	getText ()
Color	getTextColor ()
Font	getTextFont ()
void	textChanged ()
Protected Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement
	AbstractGUIElement (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final boolean opaque, @NotNull final GuiFactory guiFactory)
TooltipText	newTooltipText (@Nullable final String tooltipText)
void	tooltipChanged ()

Private Attributes
final Color	backgroundColor
final ImageIcon	backgroundImage
String	text
final Color	textColor
final Font	textFont
boolean	textHighlight
final Color	textHighlightColor

Static Private Attributes
static final long	serialVersionUID = 1

Detailed Description

Abstract base class for all label classes. It manages the label text, and renders the label's background.

Author

Lauwenmark

Andreas Kirschbaum

Definition at line 43 of file AbstractLabel.java.

Constructor & Destructor Documentation

AbstractLabel()

com.realtime.crossfire.jxclient.gui.label.AbstractLabel.AbstractLabel ( @NotNull final TooltipManager  tooltipManager, @NotNull final GUIElementListener  elementListener, @NotNull final String  name, @NotNull final String  text, @NotNull final Font  textFont, @NotNull final Color  textColor, @NotNull final Color  textHighlightColor, @Nullable final BufferedImage  backgroundPicture, @Nullable final Color  backgroundColor, @NotNull final GuiFactory  guiFactory  )

protected

Creates a new instance.

Parameters

tooltipManager	the tooltip manager to update
elementListener	the element listener to notify
name	the name of this element
text	the text
textFont	the text font
textColor	the text color when not highlighted
textHighlightColor	the text color when highlighted
backgroundPicture	the optional background picture
backgroundColor	the background color; ignored if background picture is set
guiFactory	the global GUI factory instance

Definition at line 106 of file AbstractLabel.java.

References com.realtime.crossfire.jxclient.gui.label.AbstractLabel.backgroundColor, com.realtime.crossfire.jxclient.gui.label.AbstractLabel.backgroundImage, com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.elementListener, com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.guiFactory, com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.name, com.realtime.crossfire.jxclient.gui.label.AbstractLabel.text, com.realtime.crossfire.jxclient.gui.label.AbstractLabel.textColor, com.realtime.crossfire.jxclient.gui.label.AbstractLabel.textFont, com.realtime.crossfire.jxclient.gui.label.AbstractLabel.textHighlightColor, and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.tooltipManager.

Member Function Documentation

getText()

String com.realtime.crossfire.jxclient.gui.label.AbstractLabel.getText ( )

protected

Returns the label text.

Returns

the label text

Definition at line 151 of file AbstractLabel.java.

References com.realtime.crossfire.jxclient.gui.label.AbstractLabel.text.

Referenced by com.realtime.crossfire.jxclient.gui.label.GUIHTMLLabel.autoResize(), com.realtime.crossfire.jxclient.gui.label.GUIOneLineLabel.getMinimumSizeInt(), com.realtime.crossfire.jxclient.gui.label.GUIMultiLineLabel.GUIMultiLineLabel(), com.realtime.crossfire.jxclient.gui.label.GUIOneLineLabel.paintComponent(), com.realtime.crossfire.jxclient.gui.label.GUIHTMLLabel.paintComponent(), and com.realtime.crossfire.jxclient.gui.label.GUIMultiLineLabel.textChanged().

Here is the caller graph for this function:

getTextColor()

Color com.realtime.crossfire.jxclient.gui.label.AbstractLabel.getTextColor ( )

protected

Returns the text color.

Returns

the text color

Reimplemented in com.realtime.crossfire.jxclient.gui.label.GUILabelStats2, and com.realtime.crossfire.jxclient.gui.label.GUINewcharLabel.

Definition at line 169 of file AbstractLabel.java.

References com.realtime.crossfire.jxclient.gui.label.AbstractLabel.textColor, com.realtime.crossfire.jxclient.gui.label.AbstractLabel.textHighlight, and com.realtime.crossfire.jxclient.gui.label.AbstractLabel.textHighlightColor.

Referenced by com.realtime.crossfire.jxclient.gui.label.GUILabel.drawLine(), and com.realtime.crossfire.jxclient.gui.label.GUIHTMLLabel.paintComponent().

Here is the caller graph for this function:

getTextFont()

Font com.realtime.crossfire.jxclient.gui.label.AbstractLabel.getTextFont ( )

protected

Returns the font.

Returns

the font

Reimplemented in com.realtime.crossfire.jxclient.gui.label.GUINewcharLabel.

Definition at line 160 of file AbstractLabel.java.

References com.realtime.crossfire.jxclient.gui.label.AbstractLabel.textFont.

Referenced by com.realtime.crossfire.jxclient.gui.label.GUIHTMLLabel.autoResize(), com.realtime.crossfire.jxclient.gui.label.GUILabel.drawLine(), com.realtime.crossfire.jxclient.gui.label.GUIOneLineLabel.getMinimumSizeInt(), com.realtime.crossfire.jxclient.gui.label.GUIMultiLineLabel.getTextSize(), com.realtime.crossfire.jxclient.gui.label.GUIMultiLineLabel.paintComponent(), and com.realtime.crossfire.jxclient.gui.label.GUIHTMLLabel.paintComponent().

Here is the caller graph for this function:

paintComponent()

void com.realtime.crossfire.jxclient.gui.label.AbstractLabel.paintComponent

(

@NotNull final Graphics

g

)

Reimplemented in com.realtime.crossfire.jxclient.gui.label.GUIHTMLLabel, com.realtime.crossfire.jxclient.gui.label.GUIMultiLineLabel, and com.realtime.crossfire.jxclient.gui.label.GUIOneLineLabel.

Definition at line 174 of file AbstractLabel.java.

References com.realtime.crossfire.jxclient.gui.label.AbstractLabel.backgroundColor, and com.realtime.crossfire.jxclient.gui.label.AbstractLabel.backgroundImage.

setText()

void com.realtime.crossfire.jxclient.gui.label.AbstractLabel.setText

(

@NotNull final String

text

)

Sets the label text.

Parameters

text

the text

Reimplemented in com.realtime.crossfire.jxclient.gui.misc.GUILabelMessage.

Definition at line 120 of file AbstractLabel.java.

References com.realtime.crossfire.jxclient.gui.label.AbstractLabel.text, and com.realtime.crossfire.jxclient.gui.label.AbstractLabel.textChanged().

Referenced by com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.addTooltip(), com.realtime.crossfire.jxclient.gui.commands.AccountCreateCommand.execute(), com.realtime.crossfire.jxclient.gui.commands.AccountPasswordCommand.execute(), com.realtime.crossfire.jxclient.window.GuiManager.openDialog(), com.realtime.crossfire.jxclient.gui.list.GUIItemList< GUIItemSpell >.selectionChanged(), com.realtime.crossfire.jxclient.gui.list.GUIMetaElementList.selectionChanged(), com.realtime.crossfire.jxclient.window.GuiManager.updateConnectLabel(), com.realtime.crossfire.jxclient.gui.label.GUINewcharLabel.updateContents(), and com.realtime.crossfire.jxclient.gui.label.GUILabelStats2.updateStat().

Here is the call graph for this function:

Here is the caller graph for this function:

setTextHighlight()

void com.realtime.crossfire.jxclient.gui.label.AbstractLabel.setTextHighlight

(

final boolean

textHighlight

)

Sets whether the text should be highlighted.

Parameters

textHighlight

whether the text is highlighted

Definition at line 131 of file AbstractLabel.java.

References com.realtime.crossfire.jxclient.gui.label.AbstractLabel.textChanged(), and com.realtime.crossfire.jxclient.gui.label.AbstractLabel.textHighlight.

Here is the call graph for this function:

textChanged()

void com.realtime.crossfire.jxclient.gui.label.AbstractLabel.textChanged ( )

protected

Will be called whenever text or getTextColor() has changed.

Reimplemented in com.realtime.crossfire.jxclient.gui.label.GUIHTMLLabel, com.realtime.crossfire.jxclient.gui.label.GUIMultiLineLabel, and com.realtime.crossfire.jxclient.gui.label.GUILabel.

Definition at line 142 of file AbstractLabel.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.AbstractLabel.setText(), and com.realtime.crossfire.jxclient.gui.label.AbstractLabel.setTextHighlight().

Here is the caller graph for this function:

Member Data Documentation

backgroundColor

final Color com.realtime.crossfire.jxclient.gui.label.AbstractLabel.backgroundColor

private

If set, the opaque background color. This field is ignored if backgroundImage is set.

Definition at line 85 of file AbstractLabel.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.AbstractLabel.AbstractLabel(), com.realtime.crossfire.jxclient.gui.misc.GUIDialogTitle.GUIDialogTitle(), com.realtime.crossfire.jxclient.gui.label.GUIHTMLLabel.GUIHTMLLabel(), com.realtime.crossfire.jxclient.gui.label.GUILabel.GUILabel(), com.realtime.crossfire.jxclient.gui.label.GUILabelFailure.GUILabelFailure(), com.realtime.crossfire.jxclient.gui.misc.GUILabelMessage.GUILabelMessage(), com.realtime.crossfire.jxclient.gui.label.GUILabelQuery.GUILabelQuery(), com.realtime.crossfire.jxclient.gui.label.GUILabelStats.GUILabelStats(), com.realtime.crossfire.jxclient.gui.label.GUILabelStats2.GUILabelStats2(), com.realtime.crossfire.jxclient.gui.label.GUIMultiLineLabel.GUIMultiLineLabel(), com.realtime.crossfire.jxclient.gui.label.GUIOneLineLabel.GUIOneLineLabel(), and com.realtime.crossfire.jxclient.gui.label.AbstractLabel.paintComponent().

backgroundImage

final ImageIcon com.realtime.crossfire.jxclient.gui.label.AbstractLabel.backgroundImage

private

The background image. It takes precedence over backgroundColor.

Definition at line 78 of file AbstractLabel.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.AbstractLabel.AbstractLabel(), and com.realtime.crossfire.jxclient.gui.label.AbstractLabel.paintComponent().

serialVersionUID

final long com.realtime.crossfire.jxclient.gui.label.AbstractLabel.serialVersionUID = 1

staticprivate

The serial version UID.

Definition at line 48 of file AbstractLabel.java.

text

String com.realtime.crossfire.jxclient.gui.label.AbstractLabel.text

private

The label text.

Definition at line 54 of file AbstractLabel.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.AbstractLabel.AbstractLabel(), com.realtime.crossfire.jxclient.gui.label.GUILabel.drawLine(), com.realtime.crossfire.jxclient.gui.label.AbstractLabel.getText(), com.realtime.crossfire.jxclient.gui.label.GUIHTMLLabel.GUIHTMLLabel(), com.realtime.crossfire.jxclient.gui.label.GUILabel.GUILabel(), com.realtime.crossfire.jxclient.gui.label.GUIMultiLineLabel.GUIMultiLineLabel(), com.realtime.crossfire.jxclient.gui.label.GUIOneLineLabel.GUIOneLineLabel(), com.realtime.crossfire.jxclient.gui.label.AbstractLabel.setText(), and com.realtime.crossfire.jxclient.gui.misc.GUILabelMessage.setText().

textColor

final Color com.realtime.crossfire.jxclient.gui.label.AbstractLabel.textColor

private

The text color when not highlighted.

Definition at line 66 of file AbstractLabel.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.AbstractLabel.AbstractLabel(), com.realtime.crossfire.jxclient.gui.label.AbstractLabel.getTextColor(), com.realtime.crossfire.jxclient.gui.misc.GUIDialogTitle.GUIDialogTitle(), com.realtime.crossfire.jxclient.gui.label.GUILabel.GUILabel(), com.realtime.crossfire.jxclient.gui.label.GUILabelStats.GUILabelStats(), com.realtime.crossfire.jxclient.gui.label.GUIMultiLineLabel.GUIMultiLineLabel(), and com.realtime.crossfire.jxclient.gui.label.GUIOneLineLabel.GUIOneLineLabel().

textFont

final Font com.realtime.crossfire.jxclient.gui.label.AbstractLabel.textFont

private

The font for rendering the label text.

Definition at line 60 of file AbstractLabel.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.AbstractLabel.AbstractLabel(), com.realtime.crossfire.jxclient.gui.label.AbstractLabel.getTextFont(), com.realtime.crossfire.jxclient.gui.misc.GUIDialogTitle.GUIDialogTitle(), com.realtime.crossfire.jxclient.gui.label.GUILabel.GUILabel(), com.realtime.crossfire.jxclient.gui.label.GUILabelStats.GUILabelStats(), com.realtime.crossfire.jxclient.gui.label.GUIMultiLineLabel.GUIMultiLineLabel(), and com.realtime.crossfire.jxclient.gui.label.GUIOneLineLabel.GUIOneLineLabel().

textHighlight

boolean com.realtime.crossfire.jxclient.gui.label.AbstractLabel.textHighlight

private

Whether the text is currently highlighted.

Definition at line 90 of file AbstractLabel.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.AbstractLabel.getTextColor(), and com.realtime.crossfire.jxclient.gui.label.AbstractLabel.setTextHighlight().

textHighlightColor

final Color com.realtime.crossfire.jxclient.gui.label.AbstractLabel.textHighlightColor

private

The text color when highlighted.

Definition at line 72 of file AbstractLabel.java.

Referenced by com.realtime.crossfire.jxclient.gui.label.AbstractLabel.AbstractLabel(), com.realtime.crossfire.jxclient.gui.label.AbstractLabel.getTextColor(), com.realtime.crossfire.jxclient.gui.label.GUILabel.GUILabel(), com.realtime.crossfire.jxclient.gui.label.GUILabelStats.GUILabelStats(), and com.realtime.crossfire.jxclient.gui.label.GUIOneLineLabel.GUIOneLineLabel().

---

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

• src/gui/src/main/java/com/realtime/crossfire/jxclient/gui/label/AbstractLabel.java