de.frame4j.graf

Class QuadShpIcon

java.lang.Object

de.frame4j.graf.QuadShpIcon

All Implemented Interfaces:

Paintable, Serializable, Icon

public class QuadShpIcon
extends Object
implements Icon, Serializable, Paintable

Square icon containing a polygon.

Objects of this class are small quadratic images embedding a figure. As Icon it may be used as a JButton's face.

With, e.g., an isosceles triangle you have up, down, left and right buttons with variable colour and fill state for HMI control panels.


© Copyright 2004 Albrecht Weinert

Version:

1 (14.01.2017)

Author:

Albrecht Weinert

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	anzPoints Number of polygon points.
static int	DOWN Icon-Typ.
boolean	filled Filled or just lines.
protected boolean	getFgColFromComp Flag: as colour to paint with use embedding component's foreground colour.
protected static QuadShpIcon[]	icons
static int	LEFT Icon-Typ.
static int	RIGHT Icon-Typ.
int	size Surrounding square's size.
protected static int[]	sizes
static int	SQUARE Icon-Typ.
protected static int[]	typs
static int	UP Icon-Typ.
protected static int	UPDNCSZ
protected int[]	xPs
protected int[]	yPs

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QuadShpIcon(int size, int[] xPs, int[] yPs, boolean filled) Constructor without any checks.
	QuadShpIcon(QuadShpIcon must, boolean filled) Construction another quadratic shaped icon according a template one.

Method Summary

Modifier and Type	Method and Description
int	getIconHeight()
int	getIconWidth()
static QuadShpIcon	makeShapeIcon(Icon must, boolean filled) Make another quadratic shaped icon according a template one.
static QuadShpIcon	makeShapeIcon(int size, int[] xPs, int[] yPs, boolean filled) Make a quadratic shaped icon.
static QuadShpIcon	makeUpDownIcon(int size, int typ, boolean filled) Make a quadratic shaped icon of standard type.
void	paint(Graphics g, int x, int y, int w, int h) Implementing Paintable.
void	paintIcon(Component c, Graphics g, int x, int y) Malen als Icon.
void	paintIt(Graphics g, Color c) Re-paint at origin (0, 0).
void	setFgColor(Color fg, boolean filled) Set the colour to paint with.

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

size

public final int size

Surrounding square's size.

getIconHeight() and getIconWidth() both will return this value.

Range allowed: 5..255

getFgColFromComp

protected boolean getFgColFromComp

Flag: as colour to paint with use embedding component's foreground colour.

If true every paint process will start by getting the (embedding) component's foreground colour for painting the polygon. To be exact: It is the component provided as parameter to paintIcon(Component, Graphics, int, int).
In case of false the last colour used / set will be re-used again.

Default: true
Default start colour: sw (black)

See Also:

paintIcon(Component, Graphics, int, int), setFgColor(Color, boolean)

anzPoints

public final int anzPoints

Number of polygon points.

Range allowed: 3..12.

xPs

protected final int[] xPs

yPs

protected final int[] yPs

filled

public boolean filled

Filled or just lines.

LEFT

public static final int LEFT

Icon-Typ.

Wert: 2

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

Icon-Typ.

Wert: 4

See Also:

Constant Field Values

UP

public static final int UP

Icon-Typ.

Wert: 8

See Also:

Constant Field Values

DOWN

public static final int DOWN

Icon-Typ.

Wert: 16

See Also:

Constant Field Values

SQUARE

public static final int SQUARE

Icon-Typ.

Wert: 1

See Also:

Constant Field Values

sizes

protected static transient int[] sizes

typs

protected static transient int[] typs

icons

protected static transient QuadShpIcon[] icons

UPDNCSZ

protected static final int UPDNCSZ

See Also:

Constant Field Values

Constructor Detail

QuadShpIcon

protected QuadShpIcon(int size,
                      int[] xPs,
                      int[] yPs,
                      boolean filled)

Constructor without any checks.

To be used in factory methods or other constructors only.

QuadShpIcon

public QuadShpIcon(QuadShpIcon must,
                   boolean filled)
            throws NullPointerException

Construction another quadratic shaped icon according a template one.

Use it for same figure but different handling of colour and filled.

Throws:

NullPointerException

Method Detail

getIconHeight

public int getIconHeight()

Specified by:

getIconHeight in interface Icon

getIconWidth

public int getIconWidth()

Specified by:

getIconWidth in interface Icon

setFgColor

public final void setFgColor(Color fg,
                             boolean filled)

Set the colour to paint with.

A non null Color will be used form then on.
A null value will set paintIcon(c, g, x, y) with non null Component c taking c's foreground colour for painting.

Start defaults are black and not filled.

Parameters:

fg - New foreground colour for painting; null use actual value or set color by Compont provided to paint method(s)

filled - true: fill the polygon; false: just the lines (1px)

paintIcon

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

Malen als Icon.

Implementierung von Icon

Specified by:

paintIcon in interface Icon

Parameters:

c - Von dieser Komponente wird ggf. die Vordergrundfarbe übernommen; darf null sein.

See Also:

Icon.paintIcon(java.awt.Component, java.awt.Graphics, int, int)

paint

public final void paint(Graphics g,
                        int x,
                        int y,
                        int w,
                        int h)

Implementing Paintable.

Does paintIcon(null, g, p.x, p.y).

Specified by:

paint in interface Paintable

Parameters:

w - h will be ignoret; a QuadShpIcon has fixed quadratic size

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!]

See Also:

Paintable

paintIt

public final void paintIt(Graphics g,
                          Color c)

Re-paint at origin (0, 0).

Internal helper.

makeShapeIcon

public static QuadShpIcon makeShapeIcon(int size,
                                        int[] xPs,
                                        int[] yPs,
                                        boolean filled)
                                 throws IllegalArgumentException

Make a quadratic shaped icon.

This method makes a QuadShpIcon object with given size and polygon coordinates xPs and yPs.

The co-ordinate arrays provided will be copied. changing their values after construction will not influence the QuadShpIcon object's display figure.


Size and figure are final after construction. Colour and filled may be changed (to show state at the HMI, e.g.).

Parameters:

size - The surrounding square's size (Pixel 5..255)

xPs - the figure's X-co-ordinates; number 3..12

yPs - the figure's Y-co-ordinates; same number / array size as xPs
the polygon's start and end points do not have to coincide; it will be auto-closed

filled - start value for filled vs. just lines

Returns:

the new quadratic shaped icon

Throws:

IllegalArgumentException - if above conditions are violated

makeUpDownIcon

public static QuadShpIcon makeUpDownIcon(int size,
                                         int typ,
                                         boolean filled)
                                  throws IllegalArgumentException

Make a quadratic shaped icon of standard type.

This method does the the same as makeShapeIcon(int, int[], int[], boolean) except for choosing an isosceles triangle pointing UP, RIGHT, DOWN or LEFT or just a SQUARE of icon size.

Throws:

IllegalArgumentException

makeShapeIcon

public static QuadShpIcon makeShapeIcon(Icon must,
                                        boolean filled)
                                 throws IllegalArgumentException

Make another quadratic shaped icon according a template one.

Use it for same figure but different handling of colour and filled instead of repeating makeShapeIcon(int, int[], int[], boolean) or makeUpDownIcon(int, int, boolean) with same parameter values (no regarding filled which sets the start value of mutable state).

Parameters:

must - a QuadShpIcon (!) to share size and figure information with

filled - start value for filled vs. just lines

Returns:

the new quadratic shaped icon

Throws:

IllegalArgumentException - if must is no QuadShpIcon