ilog.tgo.swing

Class IltComponentUtilities

java.lang.Object

ilog.tgo.swing.IltComponentUtilities

public class IltComponentUtilities
extends Object

An utility class to retrieve an image that displays the graphic representation of an object in a view.

When an image is requested, it is stored in a local cache for future use. To regenerate the image, call clearObjectImage(IlpGraphicView, IlpRepresentationObject) first and then call getTinyImage(IlpGraphicView, IlpRepresentationObject).

Since:

JViews 8.5

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IltComponentUtilities() Default constructor

Method Summary

Modifier and Type	Method and Description
static void	clearImage(IlpGraphicView view, IlpRepresentationObject ro) Removes the image that has been generated for the given representation object.
void	clearObjectImage(IlpGraphicView view) Removes all images that have been created for the given view.
void	clearObjectImage(IlpGraphicView view, IlpRepresentationObject ro) Removes the image that has been generated for the given representation object.
static IltComponentUtilities	getSingleton() Returns the single instance of this class.
static Image	getTinyImage(IlpGraphicView view, IlpRepresentationObject ro) Returns an image displaying the tiny representation of the given predefined business object.

Methods inherited from class java.lang.Object

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

Constructor Detail

IltComponentUtilities

protected IltComponentUtilities()

Default constructor

Method Detail

getSingleton

public static IltComponentUtilities getSingleton()

Returns the single instance of this class.

clearObjectImage

public void clearObjectImage(IlpGraphicView view,
                             IlpRepresentationObject ro)

Removes the image that has been generated for the given representation object.

This method should be called to clear the image cache when the object attribute is changed or if any aspect of the graphic configuration is changed.

This method should also be called if the representation object is removed from the view.

Parameters:

view - View where the object is represented

ro - Representation object

clearObjectImage

public void clearObjectImage(IlpGraphicView view)

Removes all images that have been created for the given view.

This method should be called to clear the image cache when the object attribute is changed or if any aspect of the graphic configuration is changed.

This method should also be called if the representation object is removed from the view.

Parameters:

view - View where the objects are represented

getTinyImage

public static Image getTinyImage(IlpGraphicView view,
                                 IlpRepresentationObject ro)

Returns an image displaying the tiny representation of the given predefined business object.

This method creates an image that displays the tiny representation of a predefined business object (See IltObject) in a given view.

Parameters:

view - Graphic view where the object will be displayed

ro - Representation object

Returns:

Image displaying the representation of the predefined business object or null if the business object is from a custom business class.

Throws:

IllegalArgumentException - if the given representation object is not valid or is representing an object that is not an IltObject

clearImage

public static void clearImage(IlpGraphicView view,
                              IlpRepresentationObject ro)

Removes the image that has been generated for the given representation object.

This method should be called to clear the image cache when the object attribute is changed or if any aspect of the graphic configuration is changed.

This method should also be called if the representation object is removed from the view.

Parameters:

view - View where the object is represented

ro - Representation object whose image will be removed, if this argument is null all images from the given view will be removed.