com.luciad.gui.swing

LuciadLightspeedClass TLcdContrastIcon

java.lang.Object

com.luciad.gui.swing.TLcdContrastIcon

All Implemented Interfaces:

ILcdIcon, ILcdCloneable, Serializable, Cloneable

public class TLcdContrastIcon
extends Object
implements ILcdIcon, Cloneable

A contrasted/brightened version of an icon.

The contrast value modifies the contrast of the delegate icon. For example

• A contrast value of 0.0 maps all r, g and b values to 128 (grey).
• A contrast value of 0.5 maps the r, g and b ranges [0, 256) on [64, 192), so there is less contrast
• A contrast value of 1.0 doesn't modify the icon.
• A contrast value of 2.0 maps the r, g and b ranges [0, 64) on 0, [64, 192) on [0, 256) and [192, 256) on 255, So there is more contrast than in the original icon.

The brightness value is applied on the icon after applying the contrast value. It multiplies the r, g and b values with the brightness value. For example

• A brightness value of 0.0 makes the icon black.
• A brightness value of 1.0 doesn't modify the icon.
• A brightness value of 2.0 makes the icon twice as bright.

Notice that this class is not guaranteed to work correctly with non-static icons.

Since:

11.0

See Also:

TLcdGreyIcon, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TLcdContrastIcon(Icon aNormalIcon, double aContrast, double aBrightness) Create a new grey icon, based on the icon aNormalIcon.
TLcdContrastIcon(ILcdIcon aNormalIcon, double aContrast, double aBrightness) Create a new grey icon, based on the icon aNormalIcon.

Method Summary

Modifier and Type	Method and Description
Object	clone() Makes Object.clone() public.
int	getIconHeight() Returns the fixed height of the icon.
int	getIconWidth() Returns the fixed width of the icon.
void	paintIcon(Component c, Graphics g, int x, int y) Draw the ILcdIcon at the specified location.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdContrastIcon

public TLcdContrastIcon(ILcdIcon aNormalIcon,
                        double aContrast,
                        double aBrightness)

Create a new grey icon, based on the icon aNormalIcon. Notice that this class is not guaranteed to work correctly with non-static icons.

Parameters:

aNormalIcon - the icon of which a grey version must be created

aContrast - the applied contrast

aBrightness - the applied brightness.

TLcdContrastIcon

public TLcdContrastIcon(Icon aNormalIcon,
                        double aContrast,
                        double aBrightness)

Create a new grey icon, based on the icon aNormalIcon. Notice that this class is not guaranteed to work correctly with non-static icons.

Parameters:

aNormalIcon - the icon of which a grey version must be created

aContrast - the applied contrast

aBrightness - the applied brightness.

Method Detail

paintIcon

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

Description copied from interface: ILcdIcon

Draw the ILcdIcon at the specified location. ILcdIcon implementations may use the Component argument to get properties useful for painting, e.g. the foreground or background color.

Specified by:

paintIcon in interface ILcdIcon

Parameters:

c - a Component to retrieve properties from.

g - the Graphics on which the icon will be painted.

x - the x position where the icon will be painted. x is the first coordinate of the top left corner point of the icon.

y - the y position where the icon will be painted. y is the second coordinate of the top left corner point of the icon.

getIconWidth

public int getIconWidth()

Description copied from interface: ILcdIcon

Returns the fixed width of the icon.

Specified by:

getIconWidth in interface ILcdIcon

Returns:

the fixed width of the icon.

getIconHeight

public int getIconHeight()

Description copied from interface: ILcdIcon

Returns the fixed height of the icon.

Specified by:

getIconHeight in interface ILcdIcon

Returns:

the fixed height of the icon.

clone

public Object clone()

Description copied from interface: ILcdCloneable

Makes Object.clone() public.

When for example extending from java.lang.Object, it can be implemented like this:

 public Object clone() {
   try {
     return super.clone();
   } catch ( CloneNotSupportedException e ) {
     // Cannot happen: extends from Object and implements Cloneable (see also Object.clone)
     throw new RuntimeException( e );
   }
 }
 

Specified by:

clone in interface ILcdCloneable

Overrides:

clone in class Object

See Also:

Object.clone()