com.luciad.gui

LuciadFusionClass TLcdSingleIconProvider

java.lang.Object

com.luciad.gui.TLcdSingleIconProvider

All Implemented Interfaces:

ILcdAnchoredIcon, ILcdIcon, ILcdObjectIconProvider, ILcdCloneable, Serializable, Cloneable

public class TLcdSingleIconProvider
extends Object
implements ILcdAnchoredIcon, ILcdObjectIconProvider

Convenience wrapper for ILcdIcon that also implements ILcdObjectIconProvider by always returning itself.

Since:

2012.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TLcdSingleIconProvider(ILcdIcon aIcon)

Method Summary

Modifier and Type	Method and Description
void	anchorPointSFCT(Point aPointSFCT) Updates the given point to the location of the icon's anchor point, in relative coordinates with respect to the top left.
boolean	canGetIcon(Object o) Returns whether an icon can be returned for a given object.
Object	clone() Makes Object.clone() public.
ILcdIcon	getIcon(Object o) Returns an icon that can be used as representation for this object.
int	getIconHeight() Returns the fixed height of the icon.
int	getIconWidth() Returns the fixed width of the icon.
void	paintIcon(Component aComponent, Graphics aGraphics, int i, int i1) 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

TLcdSingleIconProvider

public TLcdSingleIconProvider(ILcdIcon aIcon)

Method Detail

paintIcon

public void paintIcon(Component aComponent,
                      Graphics aGraphics,
                      int i,
                      int i1)

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:

aComponent - a Component to retrieve properties from.

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

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

i1 - 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()

getIcon

public ILcdIcon getIcon(Object o)
                 throws IllegalArgumentException

Description copied from interface: ILcdObjectIconProvider

Returns an icon that can be used as representation for this object.

Specified by:

getIcon in interface ILcdObjectIconProvider

Parameters:

o - the domain object

Returns:

null when no ILcdIcon can be found the ILcdIcon for aObject

Throws:

IllegalArgumentException - When aObject is of the incorrect type

canGetIcon

public boolean canGetIcon(Object o)

Description copied from interface: ILcdObjectIconProvider

Returns whether an icon can be returned for a given object.

Specified by:

canGetIcon in interface ILcdObjectIconProvider

Parameters:

o - to object to check whether an icon can be provided for it.

Returns:

whether an icon can be returned for a given object.

anchorPointSFCT

public void anchorPointSFCT(Point aPointSFCT)

Description copied from interface: ILcdAnchoredIcon

Updates the given point to the location of the icon's anchor point, in relative coordinates with respect to the top left. The x-coordinate of the anchor point typically lies between 0 and getWidth(). The y-coordinate typically lies between 0 and getHeight().

Specified by:

anchorPointSFCT in interface ILcdAnchoredIcon

Parameters:

aPointSFCT - the point that has to be moved to the location of the anchor point of this icon.