JViews Diagrammer Release Notes

This document describes the main changes that have been made to the JViews Diagrammer module since version 7.5.

Incompatibilities
General Changes
Library Changes
New Packages

• ilog.views.hypergraph
• ilog.views.hypergraph.edgeconnector
• ilog.views.hypergraph.interactor
• ilog.views.hypergraph.undo

New Interfaces and Classes

• ilog.views.bpmn.IlvBPMNSelectInteractor
• ilog.views.diagrammer.faces.dhtml.component.IlvFacesDiagrammerPropertyAccessor
• ilog.views.diagrammer.faces.dhtml.renderkit.IlvFacesDiagrammerBaseRenderer
• ilog.views.diagrammer.faces.dhtml.renderkit.IlvFacesDiagrammerSelectionManagerRenderer
• ilog.views.diagrammer.faces.dhtml.renderkit.IlvFacesDiagrammerTiledViewRenderer
• ilog.views.diagrammer.faces.dhtml.taglib.IlvFacesDiagrammerSelectionManagerTag
• ilog.views.diagrammer.servlet.IlvDiagrammerCreateActionListener
• ilog.views.diagrammer.servlet.IlvDiagrammerDeleteActionListener
• ilog.views.sdm.IlvSDMCompositeContext
• ilog.views.sdm.IlvSDMCompositeInteractor
• ilog.views.sdm.modeltools.IlvContentController
• ilog.views.sdm.modeltools.IlvContentHandler
• ilog.views.sdm.modeltools.IlvVisibleAreaListener

Modified Classes

• ilog.views.diagrammer.IlvDiagrammer
• ilog.views.diagrammer.application.IlvDiagrammerAction
• ilog.views.diagrammer.application.IlvDiagrammerTree
• ilog.views.diagrammer.datasource.IlvXMLDataSource
• ilog.views.diagrammer.faces.IlvFacesDiagrammerConstants
• ilog.views.diagrammer.faces.IlvFacesDiagrammerUtil
• ilog.views.diagrammer.faces.component.IlvFacesDiagrammerView
• ilog.views.diagrammer.faces.dhtml.component.IlvFacesDHTMLDiagrammerView
• ilog.views.diagrammer.faces.dhtml.interactor.IlvFacesDiagrammerSelectInteractor
• ilog.views.diagrammer.faces.dhtml.renderkit.IlvFacesDiagrammerViewRenderer
• ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerSelectionSupport
• ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServletSupport
• ilog.views.diagrammer.faces.dhtml.taglib.IlvFacesDiagrammerSelectInteractorTag
• ilog.views.diagrammer.faces.dhtml.taglib.IlvFacesDiagrammerViewTag
• ilog.views.diagrammer.servlet.IlvDiagrammerSelectionSupport
• ilog.views.faces.dhtml.interactor.IlvFacesSelectInteractor
• ilog.views.faces.dhtml.servlet.IlvFacesManagerServletSupport
• ilog.views.faces.dhtml.servlet.IlvFacesSelectActionListener
• ilog.views.graphlayout.IlvDefaultLayoutProvider
• ilog.views.graphlayout.IlvGraphLayout
• ilog.views.graphlayout.IlvGraphLayoutUtil
• ilog.views.graphlayout.IlvGrapherAdapter
• ilog.views.graphlayout.hierarchical.IlvHierarchicalLayout
• ilog.views.graphlayout.labellayout.annealing.IlvAnnealingLabelLayout
• ilog.views.sdm.IlvSDMEngine
• ilog.views.sdm.event.SDMEngineSelectionEvent
• ilog.views.sdm.graphic.IlvURLGraphic
• ilog.views.sdm.renderer.IlvBlinkingRenderer
• ilog.views.sdm.renderer.IlvHalfZoomingRenderer
• ilog.views.sdm.renderer.IlvInteractorRenderer
• ilog.views.sdm.renderer.IlvSDMRenderer
• ilog.views.sdm.renderer.maps.IlvMapRenderer

Incompatibilities

• JSF components now have their rtexprvalue set to false instead of true in the Tag Library Definition in order to comply with JSF specification.

General Changes

• The symbol framework has been added. The symbol framework allows you to manipulate symbols and palettes of symbols. A symbol is a complex composite graphic object rendered through CSS. It can have a dynamic behavior. The basic packages of the symbol framework are described in the framework release notes.
• There is no migration tool to migrate projects based on Composite Graphics to Symbols. Composite Graphics are still working in JViews Diagrammer, just like in the previous releases. However, in the Designer, it is not recommmended to mix Composite Graphics with Symbols, as style rules may not apply correctly on both types of object at the same time. The Designer allows you to modify existing rules with Composite Graphics, but it creates new rules only with Symbols. To fully migrate projects with the Designer, start the New Diagram Wizard, load the old XML project file (or the old data source project), and create new style rules with Symbols. The resulting project will contain only Symbols.
• A Symbol Editor is provided for designing symbols interactively. It is a WYSIWYG editor. The Symbol Editor module documentation can be found  here. 
• The dashboard module has been created. A dashboard is a basic Diagrammer application which displays gauge symbols connected to user data. The module comes with a WYSIWYG editor. The dashboard module documentation can be found  here.  The samples/dashboard directory contains the source code of the provided dashboard editor, and two other samples: Business Activity Monitoring (BAM)  and Tunnel Monitoring.
  
• Content on Demand. This tool helps constructing diagram with plugged onto an expensive model. The term "expensive" here refers to a model that has a large memory footprint or a model which takes a long time to load (for example, database requests for populating the model). The content-on-demand tool assumes that all models are existing, but can be "hollow". Each model object is loaded only when necessary, for example when its graphic representation enters in the visible area. Optionally, the model object can receive an unload event when the graphic representation is no longer visible.
• Detail levels. Diagrammer defines now three detail levels. They are global pseudo-classes and can impact style rules that set conditions on the current detail level. The intention is to allow style rules that define simpler and smaller graphical representations of the same objects as the detail level is set lower and lower.
• The hypergraph data structures have been added. A hypergraph consists of nodes and hyperedges. A hyperedge can connect multiple source nodes and multiple target nodes (while a normal link can only connect one source node and one target node). In this version of JViews, only the graphic data structures of hypergraphs are provided. CSS and layout support for hypergraphs will be added in future versions of JViews.
• The JSF DHTML-based thin clients now have new Ajax features allowing to edit the diagram by adding nodes and links and by editing their properties or removing them.
• The JSF DHTML-based thin clients now have the ability to tile the view allowing to cache portion of it when panning or zooming.
• The JSF DHTML-based thin clients now have the ability to display dashboards.
• The BPMN Modeler now uses a specific select interactor to expand and collapse sub-processes.

Library Changes

New Packages

ilog.views.hypergraph

This package contains the graphic framework for hypergraphs. A hypergraph contains nodes and hyperedges. A hyperedge can connect multiple source nodes and multiple target nodes.

ilog.views.hypergraph.edgeconnector

This package contains the predefined hyperedge connectors.

ilog.views.hypergraph.interactor

This package contains the predefined view interactors for hypergraphs.

ilog.views.hypergraph.undo

This package contains the undo support for hypergraphs.

New Interfaces and Classes

ilog.views.bpmn.IlvBPMNSelectInteractor

The IlvBPMNSelectInteractor class is to be used with a BPMN diagram instead of ilog.views.sdm.interactor.IlvSDMCompositeSelectInteractor in order to handle the mouse events that expand and collapse the BPMN diagram sub-processes.

ilog.views.diagrammer.faces.dhtml.component.IlvFacesDiagrammerPropertyAccessor

The IlvFacesDiagrammerPropertyAccessor class let the ilog.views.diagrammer.faces.dhtml.component.IlvFacesDiagrammerSelectionManager access the properties of the selected objects for read or write operations.

ilog.views.diagrammer.faces.dhtml.renderkit.IlvFacesDiagrammerBaseRenderer

This class is the base renderer of JViews Diagrammer based view renderers.

ilog.views.diagrammer.faces.dhtml.renderkit.IlvFacesDiagrammerSelectionManagerRenderer

This class is the renderer for an IlvFacesDiagrammerSelectionManager component.

ilog.views.diagrammer.faces.dhtml.renderkit.IlvFacesDiagrammerTiledViewRenderer

This renderer is the DHTML diagrammer or dashboard renderer when the view is tiled.

ilog.views.diagrammer.faces.dhtml.taglib.IlvFacesDiagrammerSelectionManagerTag

This class defines the JSP custom tag handler for the ilog.views.diagrammer.faces.dhtml.component.IlvFacesDiagrammerSelectionManager component and its specific DHTML renderer.

ilog.views.diagrammer.servlet.IlvDiagrammerCreateActionListener

This class defines a server action that is in charge of creating JViews Diagrammer nodes or links.

ilog.views.diagrammer.servlet.IlvDiagrammerDeleteActionListener

This class defines a server action that is in charge of deleting JViews Diagrammer nodes or links.

ilog.views.sdm.IlvSDMCompositeContext

This helper class is the implementation of IlvCompositeContext for SDM.

ilog.views.sdm.IlvSDMCompositeInteractor

The object interactor that is used on the composite graphics to invoke Swing actions.

ilog.views.sdm.modeltools.IlvContentController

An independent class that manages content loading and unloading.

ilog.views.sdm.modeltools.IlvContentHandler

This class is used by IlvContentController to handle the loading and unloading of the SDM model object contents.

ilog.views.sdm.modeltools.IlvVisibleAreaListener

This class allows you to listen to changes in the visible area of a view, and to request the controller to lock the new visible area.

Modified Classes

ilog.views.diagrammer.IlvDiagrammer

• New methods:
  • createXMLDataSource(): Factory for XML data source.
  • setProject(IlvDiagrammerProject): Loads a project in this diagram component.

ilog.views.diagrammer.application.IlvDiagrammerAction

• Overview of new features:
  • It is possible to programmatically select a  file in the file chooser used by JViews Diagrammer actions before it is activated.
    
• New methods:
  • getDefaultSelectedFile(): Returns the default selected file of the file chooser.
  • setDefaultSelectedFile(File): Sets the default selected file of the file chooser.

ilog.views.diagrammer.application.IlvDiagrammerTree

• New method:
  • makeTreeNodeItemLabel(Object, String): Creates the tree item label for sdmObject. This method lets you customize the tree items.

ilog.views.diagrammer.datasource.IlvXMLDataSource

• New method:
  • getConnector(): Returns XML connector.

ilog.views.diagrammer.faces.IlvFacesDiagrammerConstants

• New fields:
  • DASHBOARD_DIAGRAM: The IlvDashboardDiagram instance that is wrapped in the faces component.
  • EDITABLE: The editable state of the ilog.views.diagrammer.faces.component.IlvFacesDiagrammerView
  • PROPERTY_ACCESSOR: The propertyAccessor property of the ilog.views.diagrammer.faces.dhtml.component.IlvFacesDiagrammerSelectionManager.

ilog.views.diagrammer.faces.IlvFacesDiagrammerUtil

• New methods:
  • getDashboardDiagram(IlvSDMView): Returns the ilog.views.diagrammer.IlvDiagrammer object attached to an SDM view.

ilog.views.diagrammer.faces.component.IlvFacesDiagrammerView

• Overview of new features:
  • Ability to edit the view contents.
• New methods:
  • isEditable(): Returns whether or not the IlvFacesDiagrammerView is editable.
  • setEditable(boolean): Sets whether or not the IlvFacesDiagrammerView is editable.

ilog.views.diagrammer.faces.dhtml.component.IlvFacesDHTMLDiagrammerView

• Overview of new features:
  • Ability to tile the view contents.
• New methods:
  • getTileManager():
  • setTileManager(IlvTileManager):

ilog.views.diagrammer.faces.dhtml.interactor.IlvFacesDiagrammerSelectInteractor

• New methods:
  • isDeletionAllowed(): Returns whether it's allowed to delete the current selection of the selection manager using the delete key when this interactor is set on the view.
  • setDeletionAllowed(boolean): Sets whether it's allowed to delete the current selection of the selection manager using the delete key when this interactor is set on the view.


• New field:
  • DELETION_ALLOWED_DEFAULT_VALUE: The default value of deletionAllowed property.

ilog.views.diagrammer.faces.dhtml.renderkit.IlvFacesDiagrammerViewRenderer

• New methods:
  • processData(FacesContext, UIComponent, Object): This method processes the data property to properly configure the component.
  • resetData(UIComponent): This method resets the data property to properly de-configure the component.

ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerSelectionSupport

• New method:
  • setAdditionalProperties(IlvSelectionSupport.IlvSelectionResponse, Object, List): This method is called to set additional properties on the given Object following a client-side request.

ilog.views.diagrammer.faces.dhtml.servlet.IlvFacesDiagrammerServletSupport

• New methods:
  • getValue(HttpServletRequest, String): Overridden to use JSF context.
  • setValue(HttpServletRequest, String, Object): Overridden to use JSF context.
  • prepareManagerView(HttpServletRequest, IlvManagerView): Overridden to configure the manager view for tiling.

ilog.views.diagrammer.faces.dhtml.taglib.IlvFacesDiagrammerSelectInteractorTag

• New methods:
  • getDeletionAllowed(): Returns whether it's allowed to delete the current selection of the selection manager using the delete key when this interactor is set on the view.
  • setDeletionAllowed(String): Sets whether it's allowed to delete the current selection of the selection manager using the delete key when this interactor is set on the view.

ilog.views.diagrammer.faces.dhtml.taglib.IlvFacesDiagrammerViewTag

• New methods:
  • getEditable(): Returns whether or not the component is editable.
  • setEditable(String): Sets whether or not the component is editable.

ilog.views.diagrammer.servlet.IlvDiagrammerSelectionSupport

• New method:
  • doPostSetProperties(HttpServletRequest, IlvSelectionSupport.IlvSelectionResponse, List): This method is called to manage the update on the server-side of properties that have been changed on selected objects on the client-side.

ilog.views.faces.dhtml.interactor.IlvFacesSelectInteractor

• New method:
  • isImageMode(): Returns the image mode.

ilog.views.faces.dhtml.servlet.IlvFacesManagerServletSupport

• New method:
  • prepareManagerView(HttpServletRequest, IlvManagerView): Overridden to configure the manager view for tiling.


• New field:
  • TILE_MANAGER_PARAM:

ilog.views.faces.dhtml.servlet.IlvFacesSelectActionListener

• New method:
  • createFakeView(IlvManagerView): Returns the fake JSF view component used in the fake value change event.

ilog.views.faces.dhtml.taglib.IlvFacesViewTag

• New methods:
  • getMaxZoomLevel(): Returns the maximum zoom level.
  • setMaxZoomLevel(String): Sets the maximum zoom level.
  • getStaticLayersCount(): Returns the number of static layers.
  • setStaticLayersCount(String): Sets the number of static layers.
  • getTileManager(): Returns the tile manager responsible for retrieving and/or storing image tiles on the server side.
  • setTileManager(String): Sets the tile manager responsible for retrieving and/or storing image tiles on the server side.
  • getTileSize(): Returns the tile size.
  • setTileSize(String): Sets the tile size.
  • getVisibleLayers(): Returns the visible manager layer names.
  • setVisibleLayers(String): Sets the visible manager layer names.
  • getZoomLevels(): Returns the fixed zoom levels displayed by the view.
  • setZoomLevels(String): Sets the fixed zoom levels displayed by the view.

ilog.views.graphlayout.IlvDefaultLayoutProvider

• New method:
  • storePreferredLayout(IlvGraphModel, IlvGraphLayout): Stores the layout for the graph model.

ilog.views.graphlayout.IlvGraphLayout

• New method:
  • beforeLayout(boolean): Performs preprocessing operations before the layout of the entire graph.

ilog.views.graphlayout.IlvGraphLayoutUtil

• Overview of new features:
  • Provides some basic utilities for sorting. This is used to sort the nodes of a graph model.
• New methods:
  • CreateSortedEnumeration(Enumeration, Comparator): Returns a new enumeration containing the same elements as the provided enumeration, but ordered according to the provided comparator.
  • Sort(Object[], Comparator): Sorts the provided objects according to the provided comparator.

ilog.views.graphlayout.IlvGrapherAdapter

• Overview of new features:
  • It is now possible to pass the nodes to the layout algorithm in a sorted order. This can help to increase the stability of the layout, that is, performing layout of the same graph produces the same result even when the internal order of the graph is no longer the same.
• New methods:
  • getNodeComparator(): Returns the comparator used for sorting the nodes.
  • setNodeComparator(Comparator): Sets the comparator used for sorting the nodes.

ilog.views.graphlayout.hierarchical.IlvHierarchicalLayout

• New method:
  • beforeLayout(boolean): Performs preprocessing operations before the layout of the entire graph.

ilog.views.graphlayout.labellayout.annealing.IlvAnnealingLabelLayout

• New method:
  • getLabelsOfObstacle(Object): Returns the labels associated with an obstacle.

ilog.views.sdm.IlvSDMEngine

• Overview of new features:
  • Three levels of detail.
  • Possibility to set global pseudoclasses.
  • Possibility to select several objects at once (generates one event).
• New methods:
  • getDetailLevel(): Returns the pseudoclass that represents the current level of detail.
  • setDetailLevel(String): Sets the current level of detail.
  • getPseudoClasses(): Returns the pseudoclasses associated with all data objects.
  • setPseudoClasses(String[]): Sets the pseudoclasses associated with all data objects.
  • setSelected(Object[], boolean): Selects or deselects the graphic objects representing the specified array of data objects.
  • setStyleSheets(int, String, boolean): Same as setStyleSheets(int, String), with the possibility to not recreate the diagram.


• New fields:
  • HIGH_DETAIL_LEVEL: The pseudoclass "high-detail-level" that indicates a high level of detail.
  • LOW_DETAIL_LEVEL: The pseudoclass "low-detail-level" that indicates a low level of detail.
  • MEDIUM_DETAIL_LEVEL: The pseudoclass "medium-detail-level" that indicates a medium level of detail.

ilog.views.sdm.event.SDMEngineSelectionEvent

• Overview of new features:
  • Added adjusting state in event.
• New methods:
  • isAdjusting(): Returns adjusting value.
  • setAdjusting(boolean): Set whether this event is multiple or not.

ilog.views.sdm.graphic.IlvURLGraphic

• Overview of new features:
  • Added flush method.
• New method:
  • flush(): Flushes URL cache for this instance.

ilog.views.sdm.renderer.IlvBlinkingRenderer

• New field:
  • TOGGLE_VISIBILITY: The "ToggleVisibility" renderer property.

ilog.views.sdm.renderer.IlvHalfZoomingRenderer

• Overview of new features:
  • Graphic objects wrapped in half zooming graphics can now be made transparent.
• New methods:
  • getAlpha(): Returns the alpha transparency value for the objects.
  • setAlpha(float): Changes the alpha transparency value for the objects.

ilog.views.sdm.renderer.IlvInteractorRenderer

• Overview of new features:
  • Ability to enable/disable all shortcuts.
• New methods:
  • isShorcutEnabled(): Enables or disables all object interactors at once.
  • setShorcutEnabled(boolean): Enables or disables shortcuts for all interactors at once.

ilog.views.sdm.renderer.IlvSDMRenderer

• New method:
  • callMoveResizeNodeGraphic(IlvSDMEngine, Object, IlvGraphic, IlvRect, int): Move the graphic to its final position.

ilog.views.sdm.renderer.maps.IlvMapRenderer

• New methods:
  • isUsingThreads(): Indicates whether the map read should use threads to load images and/or map data sources.
  • setUsingThreads(boolean): Determines whether the map read should use threads to load images and/or map data sources.

Example Changes

• An example that shows content on demand was added. It can be found here.
• An example that shows hypergraphs was added. It can be found here.
• An example that show how to edit a diagram in a JSF DHTML-based thin client has been added. It can be found here
• An example that show how to display a diagram in a portlet using JSF DHTML-based thin client has been added. It can be found here.