Package ilog.views.prototypes

Provides legacy facilities that allow you to define custom graphic objects easily.

See: Description

Interface Summary

Interface	Description
IlvGroupTraverser	The interface IlvGroupTraverser is used to recursively traverse all the elements belonging to a group.
IlvInteractiveBehavior	This interface must be implemented by subclasses of IlvBehavior that want to handle mouse/keyboard events.
IlvPrototypeLibraryEditor	The interface IlvPrototypeLibraryEditor is used by applications that edit prototype libraries and that need to be notified when these libraries are loaded.
IlvValueFilter	An IlvValueFilter object is called by the class IlvValueConverter to convert a value from one type to another.

Class Summary

Class	Description
IlvActionBehavior	Deprecated You should use the class IlvEventBehavior rather than this one to handle user events in a prototype.
IlvAnimationBehavior	The class IlvAnimationBehavior is the base class for all the behavior objects used to produce animation effects.
IlvBehavior	The class IlvBehavior is the base class for all the objects that handle a particular behavior.
IlvBlinkBehavior	The class IlvBlinkBehavior is a subclass of IlvAnimationBehavior that makes an object flash on and off at a specified time interval.
IlvClockValueSource	The class IlvClockValueSource is used to generate values at a specified time interval.
IlvCompositeBehavior	The class IlvCompositeBehavior is used to set several values at the same time by means of a single behavior object.
IlvConditionBehavior	The IlvConditionBehavior class is used to set a property depending on a condition.
IlvConnectBehavior	The class IlvConnectBehavior is used to connect an output property to an input property of the same group.
IlvConnectInteractor	This class is a subclass of IlvManagerViewInteractor.
IlvCounterBehavior	The class IlvCounterBehavior is used to increment a specified value handled by a group.
IlvDebugBehavior	The class IlvDebugBehavior is used to debug the behavior objects attached to a group.
IlvEventBehavior	The class IlvEventBehavior is used to handle user events in a prototype.
IlvExportBehavior	The class IlvExportBehavior class maps a property of a group element to a property of the group.
IlvExportOutputBehavior	The class IlvExportOutputBehavior propagates a value generated by a group element to the whole group.
IlvExpressionBehavior	The IlvExpressionBehavior class computes an arithmetic and/or a Boolean expression.
IlvFillBehavior	The IlvFillBehavior class is used to partially fill a polygon.
IlvFormatBehavior	The class IlvFormatBehavior formats a numeric value as a string and stores the result in another value.
IlvGraphicElement	An IlvGraphicElement lets you add IlvGraphic objects to IlvGroup (or IlvPrototype) objects.
IlvGraphicGroup	The class IlvGraphicGroup is a subclass of IlvGraphicSet that encapsulates an IlvGroup.
IlvGraphicGroupInteractor	The class IlvGraphicGroupInteractor dispatches user events to a group encapsulated in an IlvGraphicGroup.
IlvGroup	An IlvGroup is a logical, hierarchical collection of objects.
IlvGroupBag	The class IlvGroupBag is used to manage logical groups of graphic objects contained in a manager.
IlvGroupBehavior	The IlvGroupBehavior class is used to define properties that will be applied to all the elements of a group.
IlvGroupElement	The class IlvGroupElement is the abstract base class for all the objects contained in instances of IlvGroup.
IlvGroupFrame	Instances of the class IlvGroupFrame are graphic objects used to display a rectangle around an IlvGroup object inside a manager.
IlvGroupInteractor	The class IlvGroupInteractor is a subclass of IlvObjectInteractor that can be used to define user interactions on a graphic element of a group.
IlvInheritBehavior	The class IlvInheritBehavior makes it possible for various groups (or prototypes) to share behavior objects.
IlvInvertBehavior	The class IlvInvertBehavior is a subclass of IlvAnimationBehavior that inverts two values of an object at a specified time interval.
IlvJavaBehavior	The class IlvJavaBehavior is used to specify the side effects associated with a property by writing Java code.
IlvMakePrototypeInstanceInteractor	This class is a subclass of IlvDragRectangleInteractor that is used to interactively create prototype instances.
IlvMinMaxBehavior	The class IlvMinMaxBehavior is used to test whether a value is contained between a minimum and a maximum value.
IlvMultiRepBehavior	The class IlvMultiRepBehavior is used to set the graphic representation of a group depending on an integer value.
IlvOutputBehavior	The class IlvOutputBehavior is used to explicitly generate a value.
IlvPrototype	The class IlvPrototype implements groups that can be duplicated and reused in applications.
IlvPrototypeBeanSupport	Support for beans generated from prototypes.
IlvPrototypeInstance	The IlvPrototypeInstance class represents the instances (or clones) of a prototype.
IlvPrototypeLibrary	The class IlvPrototypeLibrary is used to organize, load, and save prototypes.
IlvRandomValueSource	The class IlvRandomValueSource is a subclass of IlvClockValueSource that generates a random value at a specified time interval.
IlvRotateBehavior	The class IlvRotateBehavior is used to rotate a prototype element at a specified time interval.
IlvRotationBehavior	The class IlvRotationBehavior is used to set the angle of a prototype element.
IlvScaleBehavior	The class IlvScaleBehavior is used to set the vertical or horizontal scaling factor that is applied to a specific group element.
IlvSingleBehavior	The class IlvSingleBehavior is an abstract class that provides a simple way of defining behavior objects which handle a single property.
IlvTimerBehavior	The class IlvTimerBehavior is a subclass of IlvAnimationBehavior that modifies a property of the prototype periodically.
IlvToggleBehavior	The class IlvToggleBehavior is used to toggle a Boolean value between true and false.
IlvTranslateBehavior	The class IlvTranslateBehavior is used to set the horizontal or vertical position of a prototype element.
IlvTriggerBehavior	The class IlvTriggerBehavior is used to trigger the setting of another value.
IlvValueBehavior	The class IlvValueBehavior is used to store a value.
IlvValueConverter	The class IlvValueConverter is used to convert a value from one type to another.
IlvValueSource	The class IlvValueSource is the base class of all objects that generate values.

Exception Summary

Exception	Description
IlvFileValueException	IlvFileValueException is a subclass of IlvReadFileException which indicates that the values of a prototype (or prototype instance) read from a file could not be initialized.
IlvGroupException	Exceptions of the class IlvGroupException are thrown by the class IlvGroup when an error occurs in a group (for example, when a group element is not found).
IlvValueException	Exceptions of the class IlvValueException are thrown by the IlvGroupElement subclasses.
IlvValuesNotHandledException	This subclass of IlvValueException is used to signal that one or more of the values passed to the methods set or get have not been handled by an IlvGroupElement object.

Package ilog.views.prototypes Description

Provides legacy facilities that allow you to define custom graphic objects easily. The package is delivered for backward compatibility reasons. The recommended way to define custom graphic objects today is by using the composite graphic framework instead of the prototypes framework.

The core package of Perforce JViews provides basic graphic objects to build your applications: lines, rectangles, ellipses, splines, etc. Using prototypes, you can enrich this set of graphic objects by defining your own custom graphic objects.

Prototypes are meant to be designed using the Perforce JViews editor, IlvEdit. You draw the graphic appearance of a prototype in an IlvEdit buffer by assembling basic graphic objects (lines, rectangles, etc) or instances of other prototypes.

Prototypes are not simply static combinations of graphics: you can make them active by defining their properties, and associating these properties with graphic feedback and animations.

The classes of this package can be divided in two categories: the classes that you use to load and access existing prototypes in your applications, and the classes that you use to create new prototypes.

Using Prototypes in Applications

The central class of the prototypes package is IlvGroup. A group is a hierarchy of elements (instances of subclasses of IlvGroupElement. Group elements can contain graphic objects (class IlvGraphicElement) or sub-groups.

A prototype is the "model" of a custom graphic object that you have created with IlvEdit. It is an instance of the class IlvPrototype. Prototypes are grouped in prototype libraries (class IlvPrototypeLibrary.

To use a prototype in your application, you make a copy (or "clone") of the prototype: these clones are represented by instances of the class IlvPrototypeInstance.

Prototype instances are stored in an IlvGroupBag, which is associated with a manager. Once the prototype instances are stored in the group bag, they are drawn by the manager as if they were basic graphic objects. Prototype instances can be selected, moved, resized just like other JViews objects.

Prototypes have properties that you define when you design the prototype in IlvEdit. You read and write the values of these properties using the methods get and set of IlvGroupElement. Each property is handled by one or several instances of a subclass of IlvBehavior objects. Setting (or getting) a property will trigger the behavior objects that handle this property.

Creating New Prototypes by Coding

You can create prototypes directly by coding, although the preferred way is to use IlvEdit.

To build a prototype, you create an instance of IlvPrototype, and you add instances of IlvGraphicElement to define its graphic appearance. You can also add subgroups (instances of IlvGroup) containing other graphic elements, or instances of other prototypes (IlvPrototypeInstance).

To define the properties of the prototype, you add instance of subclasses of IlvBehavior to the prototype. There are many predefined subclasses of IlvBehavior that let you define how your prototype will react when a property is changed.

To save a prototype, you add it to a prototype library (class IlvPrototypeLibrary) and you save the library.