de.frame4j.graf

Class Tableau.Element

java.lang.Object

de.frame4j.graf.Tableau.Element

All Implemented Interfaces:

Paintable, Serializable

Enclosing class:

Tableau

public static class Tableau.Element
extends Object
implements Paintable, Serializable

An element paintable and "moorable" (fixable) within a tableau.

This (Paintable-) class is here to be a parent class for paintable tableau elements. Nevertheless this class isn't abstract.

Extending classes will override the three parameter methods paint(), paintBg() or paintString().

Objects of this class will with these methods paint a rectangular elements showing a centred text (if set) on background colour.

© Copyright Albrecht Weinert 1998 - 2001, 2004, 2015

Version:

see embedding class

Author:

Albrecht Weinert

See Also:

Tableau, paint(java.awt.Graphics, int, int, int, int), paintBg(java.awt.Graphics, int, int, int, int), paintString(java.awt.Graphics, int, int, int, int), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Color	bgColor The element's background colour.
protected Color	fgColor The element's foreground colour.
protected Font	font The element's font.
protected Font	oldFont Previous Font (for paintString only).
protected int	oldHeight Previous height (for paintString only).
protected String	oldText Previous Text (for paintString only).
protected int	oldWidth Previous width (for paintString only).
protected IntPairFix	relPos Relative text position measured (for paintString only).
protected String	text The element's font.

Constructor Summary

Constructors

Constructor and Description
Element(Color bgColor, Color fgColor, Font font, String text) Constructor with full setting.
Element(Color bgColor, Color fgColor, Font font, String text, int x, int y, int width, int height) Constructor with full setting and mooring (anchorage).

Method Summary

Modifier and Type	Method and Description
Color	getFgColor() The element's foreground colour.
Font	getFont() The element's font.
String	getText() The element's text.
void	paint(Graphics g, int x, int y, int width, int height) The one method to paint the element within the Tableau.
void	paintBg(Graphics g, int x, int y, int width, int height) Paint the background.
void	paintString(Graphics g, int x, int y, int width, int height) Paint the centred text.
void	setBgColor(Color bgColor) The element's background colour.
void	setFgColor(Color fgColor) Set the element's foreground colour.
void	setFont(Font font) Set the element's font.
void	setText(String text) Set the element's text.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.frame4j.graf.Paintable

paint, paint

Field Detail

font

protected Font font

The element's font.

See Also:

getFont()

text

protected String text

The element's font.

bgColor

protected transient Color bgColor

The element's background colour.

Default: hgr

fgColor

protected Color fgColor

The element's foreground colour.

Default: sw

oldFont

protected Font oldFont

Previous Font (for paintString only).

oldText

protected String oldText

Previous Text (for paintString only).

oldHeight

protected int oldHeight

Previous height (for paintString only).

oldWidth

protected int oldWidth

Previous width (for paintString only).

relPos

protected IntPairFix relPos

Relative text position measured (for paintString only).

Constructor Detail

Element

public Element(Color bgColor,
               Color fgColor,
               Font font,
               String text)

Constructor with full setting.

The parameter text, if not empty, will be used to label this element by this class' paint methods. It can be changed any time by setText(String).

Parameters:

bgColor - background colour

fgColor - foreground colour

font - null will get GrafVal.STD_FONT

text - first text (may be null or empty)

Element

public Element(Color bgColor,
               Color fgColor,
               Font font,
               String text,
               int x,
               int y,
               int width,
               int height)

Constructor with full setting and mooring (anchorage).

The element made will get moored in the Tableau last made. This means making an appropriate Anchor and adding it to the tableau's anchor list.

Parameters:

bgColor - background colour

fgColor - foreground colour

font - null will get GrafVal.STD_FONT

text - first text (may be changed) and also final configuration name (must not be empty)

x - mooring place, left upper corner, x-coordinate

y - mooring place, left upper corner, y-coordinate

width - Anchor's width

height - Anchor's height

Throws:

NoSuchElementException - if no Tableau has been made yet

See Also:

Tableau.lastTableau

Method Detail

getFont

public Font getFont()

The element's font.

Default: GrafVal.STD_FONT

setFont

public void setFont(Font font)

Set the element's font.

setBgColor

public void setBgColor(Color bgColor)

The element's background colour.

getFgColor

public final Color getFgColor()

The element's foreground colour.

setFgColor

public void setFgColor(Color fgColor)

Set the element's foreground colour.

getText

public String getText()

The element's text.

This text, if not empty, will be used to label this element by this class' paint methods. It can be changed any time by setText(String).

setText

public void setText(String text)

Set the element's text.

See Also:

getText()

paint

public void paint(Graphics g,
                  int x,
                  int y,
                  int width,
                  int height)

The one method to paint the element within the Tableau.

This implementation paint a borderless rectangle by using the method paintBg()) in background colour and sets the foreground colour afterwards. If there is a non empty text set it will be output centrified using the method paintString()).

If another phenotype is intended for this element this class has to be extended and one or more of the three methods mentioned have to be overriden.

Specified by:

paint in interface Paintable

Parameters:

g - The notorious Graphics object (that can nowadays be expected to be a Graphics2D).
If null this method does nothing.

x - y are the left upper corner of where to paint; y grows downwards [sic!]

width - height are the size of an surrounding rectangle to paint within; if null (0, 0) either this object's "natural" size (if there is such thing) shall be used or nothing is to be done

paintBg

public void paintBg(Graphics g,
                    int x,
                    int y,
                    int width,
                    int height)

Paint the background.

This implementation paints a border-less rectangle in background colour.

The actual colour of g is set to bgColor when this method returns.

paintString

public void paintString(Graphics g,
                        int x,
                        int y,
                        int width,
                        int height)

Paint the centred text.

This method sets the foreground colour fgColor (in g).
If text is not or empty a font will be set (if given). The text's dimensions will be evaluated and it will be output centred with respect to in d.

This exact centring with evaluating the dimension is quite resource hungry. This method remembers the data (relPos) together with the parameters (oldFont, oldText etc.), lest to repeat the same calculations over again. Inheritors are recommended to keep this procedere.

This method uses GrafHelper.paintString().