com.xmlmind.guiutil

Class TextIcon

java.lang.Object

com.xmlmind.guiutil.TextIcon

All Implemented Interfaces:

Icon

public class TextIcon
extends Object
implements Icon

An Icon where the customary image is replaced by a short, colorful, text. This kind of icon is typically used for buttons which use function keys as their shortcuts: F1, F2, F3, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static Color	STOCK_BLUE_FOREGROUND A magenta blue color (RGB(22,110,177), #166EB1, HSV(206,88,69)) which looks good with light and dark themes.

Constructor Summary

Constructors

Constructor and Description
TextIcon(String text, Font font, Color foreground, Color background, Component c) Constructs an icon where the customary image is replaced by a short, colorful, text.

Method Summary

Modifier and Type	Method and Description
Color	getBackground() Returns the color of the text background.
Color	getDisabledBackground() Returns the color of the text backgroundwhen the component owning the icon is not enabled.
Color	getDisabledForeground() Returns the color used to draw the text when the component owning the icon is not enabled.
Font	getFont() Returns the font of this icon.
Color	getForeground() Returns the color used to draw the text.
int	getIconHeight()
int	getIconWidth()
Dimension	getMinSize() Returns the minimum size for this icon.
int	getPadding() Returns the padding around the text.
String	getText() Returns the text of the icon.
void	paintIcon(Component c, Graphics g, int x, int y)
void	setBackground(Color color) Specifies the color of the text background.
void	setDisabledBackground(Color color) Specifies the color of the text background when the component owning the icon is not enabled.
void	setDisabledForeground(Color color) Specifies the color used to draw the text when the component owning the icon is not enabled.
void	setFont(Font font, Component c) Specifies the font of this icon.
void	setForeground(Color color) Specifies the color used to draw the text.
void	setMinSize(Dimension minSize, Component c) Specifies a minimum size for this icon.
void	setPadding(int padding, Component c) Specifies the padding around the text.
void	setText(String text, Component c) Specifies the text of this icon.

Methods inherited from class java.lang.Object

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

Field Detail

STOCK_BLUE_FOREGROUND

public static final Color STOCK_BLUE_FOREGROUND

A magenta blue color (RGB(22,110,177), #166EB1, HSV(206,88,69)) which looks good with light and dark themes.

Constructor Detail

TextIcon

public TextIcon(String text,
                Font font,
                Color foreground,
                Color background,
                Component c)

Constructs an icon where the customary image is replaced by a short, colorful, text.

Parameters:

text - text of the icon. May be multi-line.

font - font used to draw the text

foreground - color of the text. May be null.

background - color of the background of the text. May be null.

c - component ``owning'' this icon

Method Detail

setText

public void setText(String text,
                    Component c)

Specifies the text of this icon. May be multi-line.

getText

public String getText()

Returns the text of the icon.

setFont

public void setFont(Font font,
                    Component c)

Specifies the font of this icon.

getFont

public Font getFont()

Returns the font of this icon.

setPadding

public void setPadding(int padding,
                       Component c)

Specifies the padding around the text. Default: 0.

getPadding

public int getPadding()

Returns the padding around the text.

setForeground

public void setForeground(Color color)

Specifies the color used to draw the text. null means: text is not drawn at all (and not: text is used as a stencil when painting the background).

getForeground

public Color getForeground()

Returns the color used to draw the text. May return null.

setBackground

public void setBackground(Color color)

Specifies the color of the text background. null means: transparent background.

getBackground

public Color getBackground()

Returns the color of the text background. May return null.

setDisabledForeground

public void setDisabledForeground(Color color)

Specifies the color used to draw the text when the component owning the icon is not enabled. null means: compute the color (e.g. foreground converted to gray).

Ignored if foreground is null.

getDisabledForeground

public Color getDisabledForeground()

Returns the color used to draw the text when the component owning the icon is not enabled. May return null.

setDisabledBackground

public void setDisabledBackground(Color color)

Specifies the color of the text background when the component owning the icon is not enabled. null means: compute the color (e.g. background converted to gray).

Ignored if background is null.

getDisabledBackground

public Color getDisabledBackground()

Returns the color of the text backgroundwhen the component owning the icon is not enabled. May return null.

setMinSize

public void setMinSize(Dimension minSize,
                       Component c)

Specifies a minimum size for this icon.

getMinSize

public Dimension getMinSize()

Returns the minimum size for this icon. May return null.

getIconWidth

public int getIconWidth()

Specified by:

getIconWidth in interface Icon

getIconHeight

public int getIconHeight()

Specified by:

getIconHeight in interface Icon

paintIcon

public void paintIcon(Component c,
                      Graphics g,
                      int x,
                      int y)

Specified by:

paintIcon in interface Icon