com.alkacon.simapi

Class IdentIcon

java.lang.Object

com.alkacon.simapi.IdentIcon

public class IdentIcon
extends java.lang.Object

Renders an identity icon calculated from the given initialization String.

Default size of the icon is 32x32 pixel. The icons are generated from a grid of 4x4 patches.

This is intended to be used for generating individual icons for uses bases on their unique user name / OU combination. Based on the original Identicon implementation of Don Park, see https://github.com/donpark/identicon.

Original copyright notice:

 Copyright (c) 2007-2012 Don Park <donpark@docuverse.com>
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Color	COLOR_TRANSPARENT Constant to identify a transparent background fill color.
static java.lang.String	IDENTICON_SALT Salt String for generation better hashes.

Constructor Summary

Constructors

Constructor and Description
IdentIcon() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	drawPatch(java.awt.Graphics2D g, float x, float y, float size, int patch, int turn, boolean invert, java.awt.Color fillColor, java.awt.Color strokeColor)
protected java.awt.image.BufferedImage	drawShape(int shape) Method to draw a single shape, useful for visual testing the shape output.
java.awt.Color	getBackgroundColor() Returns the background color of the IdentIcon.
protected float	getColorDistance(java.awt.Color c1, java.awt.Color c2) Returns the distance between two colors.
protected java.awt.Color	getComplementaryColor(java.awt.Color color) Returns the complementary color for the given color.
float	getPatchSize() Returns the size in pixels at which each patch will be rendered before they are scaled down to requested IdentIcon size.
java.awt.Color	getReservedColor() Returns the reserved color for the IdentIcon renderer.
int	getSize() Returns the target image size (height, width) for the rendered patch, default is 32.
protected byte[]	hash(java.lang.String input) Generates an MD5 hash array from the given input String.
java.awt.image.BufferedImage	render(java.lang.String input) Renders the IdentIcon for the given input String.
java.awt.image.BufferedImage	render(java.lang.String input, boolean allowProtected) Renders the IdentIcon for the given input String.
java.awt.image.BufferedImage	render(java.lang.String input, boolean allowProtected, int size) Renders the IdentIcon for the given input String with the given size.
java.awt.image.BufferedImage	render(java.lang.String input, int size) Renders the IdentIcon for the given input String.
java.awt.image.BufferedImage	render(java.lang.String input, int red, int green, int blue) Renders the IdentIcon for the given input String in the given color.
protected java.awt.image.BufferedImage	renderIcon(byte[] hash, int size) Renders the IdentIcon based on the input hash, using the internal parameters.
void	setBackgroundColor(java.awt.Color backgroundColor) The background color to be used for the IdentIcon.
void	setPatchSize(float size) Set the size in pixels at which each patch will be rendered before they are scaled down to requested identicon size.
void	setReservedColor(java.awt.Color reservedColor) Returns the reserved color for the IdentIcon renderer.
void	setSize(int size) Sets the target image size (height, width) for the rendered patch, default is 32.

Methods inherited from class java.lang.Object

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

Field Detail

COLOR_TRANSPARENT

public static final java.awt.Color COLOR_TRANSPARENT

Constant to identify a transparent background fill color.

IDENTICON_SALT

public static final java.lang.String IDENTICON_SALT

Salt String for generation better hashes.

See Also:

Constant Field Values

Constructor Detail

IdentIcon

public IdentIcon()

Constructor.

Method Detail

getBackgroundColor

public java.awt.Color getBackgroundColor()

Returns the background color of the IdentIcon.

Returns:

the background color of the IdentIcon

getPatchSize

public float getPatchSize()

Returns the size in pixels at which each patch will be rendered before they are scaled down to requested IdentIcon size.

Returns:

the size in pixels at which each patch will be rendered

getReservedColor

public java.awt.Color getReservedColor()

Returns the reserved color for the IdentIcon renderer.

The default is null which disables the reserved color feature.

The reserved color can be set to make sure a certain color is only used for specific input Strings. A practical example would be "draw all admin users in orange, but no other users". In case the color calculated for the user name would be to close to the reserved color, the opposite color from the spectrum is used instead.

Returns:

the reserved color for the IdentIcon renderer

getSize

public int getSize()

Returns the target image size (height, width) for the rendered patch, default is 32.

Returns:

the target image size (height, width) for the rendered patch

render

public java.awt.image.BufferedImage render(java.lang.String input)

Renders the IdentIcon for the given input String.

The protected color in this case is NOT allowed to be used for the generated icon.

Parameters:

input - the input String to render the IdentIcon for

Returns:

the IdentIcon for the given input String

render

public java.awt.image.BufferedImage render(java.lang.String input,
                                           boolean allowProtected)

Renders the IdentIcon for the given input String.

Parameters:

input - the input String to render the IdentIcon for

allowProtected - controls if the reserves color set by getReservedColor() can be used or not

Returns:

the IdentIcon for the given input String

render

public java.awt.image.BufferedImage render(java.lang.String input,
                                           boolean allowProtected,
                                           int size)

Renders the IdentIcon for the given input String with the given size.

Good values for the size parameter should set in dependency with the patch size set with getPatchSize(). The largest size should be the patch size multiplied by four.

Parameters:

input - the input String to render the IdentIcon for

allowProtected - controls if the reserves color set by getReservedColor() can be used or not

size - the target size of the output image

Returns:

the IdentIcon for the given input String

render

public java.awt.image.BufferedImage render(java.lang.String input,
                                           int size)

Renders the IdentIcon for the given input String.

Good values for the size parameter should set in dependency with the patch size set with getPatchSize(). The largest size should be the patch size multiplied by four.

The protected color in this case is NOT allowed to be used for the generated icon.

Parameters:

input - the input String to render the IdentIcon for

size - the target size of the output image

Returns:

the IdentIcon for the given input String

render

public java.awt.image.BufferedImage render(java.lang.String input,
                                           int red,
                                           int green,
                                           int blue)

Renders the IdentIcon for the given input String in the given color.

The protected color in this case is NOT allowed to be used for the generated icon, as this method exists mostly for test purposes.

Parameters:

input - the input String to render the IdentIcon for

red - the red color component

green - the green color component

blue - the blue color component

Returns:

the IdentIcon for the given input String

setBackgroundColor

public void setBackgroundColor(java.awt.Color backgroundColor)

The background color to be used for the IdentIcon.

Parameters:

backgroundColor - the background color to set

setPatchSize

public void setPatchSize(float size)

Set the size in pixels at which each patch will be rendered before they are scaled down to requested identicon size.

Default size is 16 pixels which means, for 16-block identicon, a 64x64 image will be rendered and scaled down.

Parameters:

size - patch size in pixels

setReservedColor

public void setReservedColor(java.awt.Color reservedColor)

Returns the reserved color for the IdentIcon renderer.

The default is null which disables the reserved color feature.

The reserved color can be set to make sure a certain color is only used for specific input Strings. A practical example would be "draw all admin users in orange, but no other users". In case the color calculated for the user name would be to close to the reserved color, the opposite color from the spectrum is used instead.

Parameters:

reservedColor - the reserved color for the IdentIcon renderer to set

setSize

public void setSize(int size)

Sets the target image size (height, width) for the rendered patch, default is 32.

Parameters:

size - the target image size to set

drawPatch

protected void drawPatch(java.awt.Graphics2D g,
                         float x,
                         float y,
                         float size,
                         int patch,
                         int turn,
                         boolean invert,
                         java.awt.Color fillColor,
                         java.awt.Color strokeColor)

Parameters:

g - the graphic to draw on

x - x position

y - y position

size - size of the tile

patch - patch type to draw

turn - turn of the patch

invert - invert color or not

fillColor - fill color

strokeColor - stroke color

drawShape

protected java.awt.image.BufferedImage drawShape(int shape)

Method to draw a single shape, useful for visual testing the shape output.

Parameters:

shape - the shape to draw

Returns:

a buffered image of the shape

getColorDistance

protected float getColorDistance(java.awt.Color c1,
                                 java.awt.Color c2)

Returns the distance between two colors.

Parameters:

c1 - the first color

c2 - the second color

Returns:

the distance between the two colors

getComplementaryColor

protected java.awt.Color getComplementaryColor(java.awt.Color color)

Returns the complementary color for the given color.

Parameters:

color - the base to calculate the complementary color for

Returns:

the complementary color

hash

protected byte[] hash(java.lang.String input)

Generates an MD5 hash array from the given input String.

The IDENTICON_SALT is added to the String for better results.

Parameters:

input - the input to generate the hash for

Returns:

an MD5 hash array from the given input String

renderIcon

protected java.awt.image.BufferedImage renderIcon(byte[] hash,
                                                  int size)

Renders the IdentIcon based on the input hash, using the internal parameters.

Parameters:

hash - the hash to render

size - the size of the image to generate

Returns:

the IdentIcon based on the input hash