ilog.views.graphic

Class IlvMultipleIcon

java.lang.Object

ilog.views.IlvGraphic

ilog.views.graphic.IlvIcon

ilog.views.graphic.IlvMultipleIcon

All Implemented Interfaces:

IlvPersistentObject, IlvBlinkingObject, IlvBaseTextDirectionInterface, Transferable, ImageObserver, Serializable

public class IlvMultipleIcon
extends IlvIcon

IlvMultipleIcon is an icon that can display one image out of multiple predefined images. The table of possible images must be passed to the icon. Then the image to be displayed can be conveniently selected by an index or a key.

Example

The following code example shows how to use IlvMultipleIcon in a simple Java application:

   IlvManager manager = new IlvManager();
   IlvURLKeyTable table = new IlvURLKeyTable();
   try {
     URL filePath = new URL("file:logo.gif");
     table.add("Logo", filePath);
   } catch (MalformedURLException e) {
   }
   try {
     URL filePath = new URL("file:header.gif");
     table.add("Header", filePath);
   } catch (MalformedURLException e) {
   }
   IlvMultipleIcon icon = new IlvMultipleIcon(table);
   icon.setShowing("Header");
   manager.addObject(icon, 1, true);
 

About Graphic Objects

IlvMultipleIcon is a custom graphic object, that is, a subclass of IlvGraphic. Graphic objects are controlled using an instance of IlvManager or one of its subclasses, and displayed using one or more IlvManagerView instances in a Java Swing application. For information about generic features for graphic objects, see IlvGraphic.

Since:

JViews 8.5

See Also:

IlvManager, IlvManagerView, Serialized Form

Field Summary

Fields inherited from class ilog.views.graphic.IlvIcon

drawrect, hideStackTraceInImageUpdate

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvMultipleIcon() Creates a multiple icon.
IlvMultipleIcon(IlvInputStream stream) Reads the object from an IlvInputStream.
IlvMultipleIcon(IlvMultipleIcon source) Creates a new IlvMultipleIcon by copying an existing one.
IlvMultipleIcon(IlvURLKeyTable table) Creates a multiple icon.

Method Summary

Modifier and Type	Method and Description
IlvGraphic	copy() Copies the object.
IlvURLKeyTable	getImageTable() Returns the table containing the URLs of the images.
int	getShowIndex() Returns the index of the image currently shown by the icon.
Object	getShowing() Returns the showing indicator.
String	getShowKey() Returns the key of the image currently shown by the icon.
void	setImageTable(IlvURLKeyTable table) Sets the table containing the URLs of the images that will be displayed by this icon.
void	setShowIndex(int index) Shows an image from the table corresponding to the given index Note that this may change its bounding rectangle.
void	setShowing(Object id) Shows an image of the list according to the given parameter which can be either an index (Integer) or a key (String).
void	setShowKey(String key) Shows an image of the list corresponding to the given key Note that this may change its bounding rectangle.
void	write(IlvOutputStream stream) Writes the object to an IlvOutputStream.

Methods inherited from class ilog.views.graphic.IlvIcon

applyTransform, boundingBox, contains, draw, getAlpha, getClip, getDefinitionRect, getImage, getImageLocation, getRenderedImage, getTransformer, imageUpdate, isAutoResizing, isHighQualityRendering, setAlpha, setAutoResizing, setClip, setGraphicBag, setHighQualityRendering, setImage, setImageLocation, setRenderedImage

Methods inherited from class ilog.views.IlvGraphic

addActionListener, addNamedPropertyListener, allViewsRemoved, baseTextDirectionChanged, blinkingStateOn, boundingBox, callDraw, componentOrientationChanged, getAndAssociateObjectInteractor, getBaseTextDirection, getBlinkingAction, getBlinkingObjectOwner, getBlinkingOffPeriod, getBlinkingOnPeriod, getCenter, getComponentOrientation, getDefaultInteractor, getGraphicBag, GetGraphicObject, getIntersectionWithOutline, getLocale, getName, getNamedProperty, getObjectInteractor, getPopupMenu, getPopupMenu, getPopupMenuName, getProperty, getResolvedBaseTextDirection, getToolTipBaseTextDirection, getToolTipText, getToolTipText, getTopLevelGraphicBag, getTransferData, getTransferDataFlavors, getULocale, getZOrderIndex, hasProperty, inside, intersects, invalidateBBoxCache, invalidateBidiCache, isBaseTextDirectionSensitive, isComponentOrientationSensitive, isDataFlavorSupported, isEditable, isInApplyToObject, isLocaleSensitive, isMovable, isPersistent, isSelectable, isVisible, localeChanged, makeSelection, move, move, moveResize, needsViewNotification, notifyObjectInteractorToManager, processActionEvent, reDraw, registerBlinkingResource, removeActionListener, removeNamedProperty, removeNamedPropertyListener, removeProperty, replaceProperty, resize, rotate, scale, setBackground, setBaseTextDirection, setBaseTextDirectionDuringConstruction, setBlinkingAction, setBlinkingOffPeriod, setBlinkingOnPeriod, setEditable, setFillOn, setForeground, setInApplyToObject, setMovable, setName, setNamedProperty, setNameImpl, setObjectInteractor, setPopupMenu, setPopupMenuName, setProperty, setSelectable, setStrokeOn, setToolTipBaseTextDirection, setToolTipText, setVisible, setZOrderIndex, toString, translate, updateNeedsViewNotification, usesBidiMarkers, viewAddedOrRemoved, zoomable

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvMultipleIcon

public IlvMultipleIcon()

Creates a multiple icon.

IlvMultipleIcon

public IlvMultipleIcon(IlvURLKeyTable table)

Creates a multiple icon. The table can be shared among different icons.

IlvMultipleIcon

public IlvMultipleIcon(IlvMultipleIcon source)

Creates a new IlvMultipleIcon by copying an existing one.

Parameters:

source - The source icon.

IlvMultipleIcon

public IlvMultipleIcon(IlvInputStream stream)
                throws IlvReadFileException

Reads the object from an IlvInputStream.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - if the format is not correct.

Method Detail

copy

public IlvGraphic copy()

Copies the object. This method copies the object by calling the copy constructor.

Overrides:

copy in class IlvIcon

Returns:

A copy of the object.

See Also:

IlvGraphic

setImageTable

public void setImageTable(IlvURLKeyTable table)

Sets the table containing the URLs of the images that will be displayed by this icon. The table can be shared among different icons. Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager, you should modify the table using the applyToObject method of the manager.

Parameters:

table - The table.

getImageTable

public IlvURLKeyTable getImageTable()

Returns the table containing the URLs of the images.

Returns:

The table, which can be null.

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the object to an IlvOutputStream. You should not call this method directly; instead, you should use the write methods of the manager.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvIcon

Parameters:

stream - The output stream.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.

setShowIndex

public void setShowIndex(int index)

Shows an image from the table corresponding to the given index Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager, you should modify the table using the applyToObject method of the manager.

Parameters:

index - The index.

getShowIndex

public int getShowIndex()

Returns the index of the image currently shown by the icon. Returns -1 if the image currently shown is not from the table.

setShowKey

public void setShowKey(String key)

Shows an image of the list corresponding to the given key Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager, you should modify the table using the applyToObject method of the manager.

Parameters:

key - The key.

getShowKey

public String getShowKey()

Returns the key of the image currently shown by the icon. Returns null if the image currently shown is not from the table.

setShowing

public void setShowing(Object id)

Shows an image of the list according to the given parameter which can be either an index (Integer) or a key (String). Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager, you should modify the table using the applyToObject method of the manager.

Parameters:

id - The index or key.

getShowing

public Object getShowing()

Returns the showing indicator. This method exists only for internal reasons related to CSS styling.