com.goldencode.p2j.ui

Class EnhancedColor

java.lang.Object

com.goldencode.p2j.ui.EnhancedColor

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class EnhancedColor
extends java.lang.Object
implements java.io.Externalizable

Color that can be represented either by an RGB color or by a color index in a color table.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Integer	colorIndex Index of the color in a color table.
ColorRgb	colorRgb RGB color.

Constructor Summary

Constructors

Constructor and Description
EnhancedColor() Default constructor.
EnhancedColor(ColorRgb colorRgb) Creates an enhnaced color backed by an RGB color.
EnhancedColor(int colorIndex) Creates an enhnaced color backed by a color index.

Method Summary

Modifier and Type	Method and Description
static java.lang.Integer	getColorIndex(EnhancedColor enhancedColor) Get color index of the given enhanced color, if any.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
static ColorRgb	resolveColor(EnhancedColor enhancedColor, Window<?> window) Resolve RGB color this enhanced color represents in the specified window.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

Methods inherited from class java.lang.Object

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

Field Detail

colorRgb

public ColorRgb colorRgb

RGB color.

colorIndex

public java.lang.Integer colorIndex

Index of the color in a color table.

Constructor Detail

EnhancedColor

public EnhancedColor()

Default constructor.

EnhancedColor

public EnhancedColor(ColorRgb colorRgb)

Creates an enhnaced color backed by an RGB color.

Parameters:

colorRgb - RGB color.

EnhancedColor

public EnhancedColor(int colorIndex)

Creates an enhnaced color backed by a color index.

Parameters:

colorIndex - Index of the color in a color table.

Method Detail

resolveColor

public static ColorRgb resolveColor(EnhancedColor enhancedColor,
                                    Window<?> window)

Resolve RGB color this enhanced color represents in the specified window.

Parameters:

enhancedColor - Enhanced color to resolve. Can be null.

window - Target window.

Returns:

RGB color this enhanced color represents in the specified window. Or null if enhancedColor is null or it is backed by an invalid color index.

getColorIndex

public static java.lang.Integer getColorIndex(EnhancedColor enhancedColor)

Get color index of the given enhanced color, if any.

Parameters:

enhancedColor - Enhanced color. Can be null.

Returns:

color index of the given enhanced color or null if enhancedColor is < code>null or it is backed by an RGB color.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Replacement for the default object writing method. The latest state is written to the output destination.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - The output destination to which fields will be saved.

Throws:

java.io.IOException - In case of I/O errors.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Replacement for the default object reading method. The latest state is read from the input source.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - The input source from which fields will be restored.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If payload can't be instantiated.