ilog.views.sdm.renderer.maps

Class IlvMapStyleSheetRenderer

java.lang.Object

ilog.views.sdm.renderer.IlvSDMRenderer

ilog.views.sdm.renderer.IlvStyleSheetRenderer

ilog.views.sdm.renderer.maps.IlvMapStyleSheetRenderer

All Implemented Interfaces:

IlvStylable, Serializable

public class IlvMapStyleSheetRenderer
extends IlvStyleSheetRenderer

IlvMapStyleSheetRenderer lazily creates a map layer when a node or a link is first added. This class is intended to replace the default IlvStyleSheetRenderer when managing IlvMapLayer objects.

To use this class in your application, you must insert the following code before creating the engine:

  
   // replace the style sheet renderer with the map renderer class.
   IlvRendererUtil.addRendererAlias(
     IlvRendererUtil.getRendererAlias(IlvStyleSheetRenderer.class.getName()),
     IlvMapStyleSheetRenderer.class.getName());
 

Note: use this class only with Perforce JViews Maps.

Since:

JViews 8.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvMapStyleSheetRenderer.IlvMapSymbolManagerLayer This layer class prevents saving symbols graphic representation through ivl persistence (ie in the map file).

Field Summary

Fields

Modifier and Type	Field and Description
static String	LINK_LAYER_NAME The name of the link map layer.
static String	SYMBOL_LAYER_NAME The name of the symbol map layer.

Fields inherited from class ilog.views.sdm.renderer.IlvStyleSheetRenderer

_debug, _error, ACTUAL_LOCATION_MASK, CENTER, CLIP, defaultCSS, FREE, IMAGE_MASK, LOCATION_MASK

Fields inherited from class ilog.views.sdm.renderer.IlvSDMRenderer

PSEUDOCLASS_PREFIX

Fields inherited from interface ilog.views.util.styling.IlvStylable

APPLIED_RULE_MASK, BAD_CLASS_MASK, BAD_PROP_MASK, BAD_PROP_WITH_STACK_MASK, CREATED_MASK, DECL_MASK, DECL_VALUE_MASK, FAILED_CONVERSIONS_MASK, TIME_REPORT_MASK, WARNING_PROP_MASK

Constructor Summary

Constructors

Constructor and Description
IlvMapStyleSheetRenderer() Creates a style sheet renderer for maps.

Method Summary

Modifier and Type	Method and Description
void	addLinkGraphic(IlvSDMEngine engine, Object node, IlvGraphic graphic, boolean redraw) Creates a new link map layer if one does not already exist.
void	addNodeGraphic(IlvSDMEngine engine, Object node, IlvGraphic graphic, boolean redraw) Creates a new symbol map layer if one does not already exist.
protected IlvMapLayer	createLinkMapLayer(IlvManager manager) Creates a link layer and adds a listener that will remove all symbols if the layer is removed.
protected IlvMapLayer	createLinkMapLayer(IlvManager manager, int indexHint) Creates a link layer and adds a listener that will remove all symbols if the layer is removed.
protected IlvMapLayer	createSymbolMapLayer(IlvManager manager) Creates the symbol layer and adds a listener that will remove all symbols if the layer is removed.
protected IlvMapLayer	createSymbolMapLayer(IlvManager manager, int indexHint) Creates the symbol layer and adds a listener that will remove all symbols if the layer is removed.
protected void	customizeLayers(IlvSDMEngine engine, Object node, IlvGraphic g, String[] pseudoClass) Changes the layer of the graphic object if needed.
protected String	getLinkLayerName(int indexHint) Returns the link layer name for that SDM index.
IlvMapLayer	getLinkMapLayer(IlvManager manager) Tries to find a layer with LINK_LAYER_NAME in the IlvMapLayerTreeModel of the manager.
IlvMapLayer	getLinkMapLayer(IlvManager manager, int indexHint) Tries to find a layer with LINK_LAYER_NAME in the IlvMapLayerTreeModel of the manager.
protected String	getSymbolLayerName(int indexHint) Returns the symbol layer name for that SDM index.
IlvMapLayer	getSymbolMapLayer(IlvManager manager) Tries to find a layer with SYMBOL_LAYER_NAME in the IlvMapLayerTreeModel of the manager.
IlvMapLayer	getSymbolMapLayer(IlvManager manager, int indexHint) Tries to find a layer with getSymbolLayerName(int) in the IlvMapLayerTreeModel of the manager.

Methods inherited from class ilog.views.sdm.renderer.IlvStyleSheetRenderer

addPropertyChangeListener, clear, clear, createLinkGraphic, createLinkInstance, createNode, createNodeGraphic, createNodeInstance, customize, customizeBean, customizeBeanWithDeclarations, flushFromCaches, getBaseTextDirection, getCssClassPropertyName, getCSSEngine, getCSSRules, getDebugGraphicDecls, getDebugMask, getDeclarations, getFunction, getFunctionList, getFunctions, getGraphicProperty, getInstance, getLinkConnectionRectangle, getLinkConnectorMode, getLinksLayer, getNodesLayer, getStyleSheet, getStyleSheetDebugMask, getStyleSheets, getStyleSheets, isAddingLinkConnectors, isLinkConnectorEnabled, isOptimizeRestylingMemoizingDependencies, nodeGraphicBBoxChanged, prepareRendering, printCSS, propertiesChanged, registerFunction, removeAll, removeLinkGraphic, removeNodeGraphic, removePropertyChangeListener, setAddingLinkConnectors, setBaseTextDirection, setCssClassPropertyName, setDebugMask, setEngine, setFunctionList, setFunctions, setLinkConnectorEnabled, setLinkConnectorMode, setLinksLayer, setNodesLayer, setOptimizeRestylingMemoizingDependencies, setStyleSheet, setStyleSheetDebugMask, setStyleSheets, setStyleSheets, unregisterFunction, updateObjectProperties

Methods inherited from class ilog.views.sdm.renderer.IlvSDMRenderer

addViewListeners, callMoveResizeNodeGraphic, computeBBox, convert, convert, getAlias, getAuxiliaryBean, getAuxiliaryBeans, getEncapsulatedGraphic, getEngine, getLinkConnectionRectangle, getLocation, getParameter, linkGraphicAdded, moveResizeNodeGraphic, needsViewListeners, nodeGraphicAdded, processServerAction, propertyChanged, removeViewListeners, renderingDone, setAlias, setLayerName, setParameter

Methods inherited from class java.lang.Object

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

Field Detail

SYMBOL_LAYER_NAME

public static final String SYMBOL_LAYER_NAME

The name of the symbol map layer.

LINK_LAYER_NAME

public static final String LINK_LAYER_NAME

The name of the link map layer.

Constructor Detail

IlvMapStyleSheetRenderer

public IlvMapStyleSheetRenderer()

Creates a style sheet renderer for maps.

Method Detail

getLinkMapLayer

public IlvMapLayer getLinkMapLayer(IlvManager manager)

Tries to find a layer with LINK_LAYER_NAME in the IlvMapLayerTreeModel of the manager.

Parameters:

manager - The manager to create the map layer for.

Returns:

The map layer found or null.

Since:

JViews 8.1

getLinkMapLayer

public IlvMapLayer getLinkMapLayer(IlvManager manager,
                                   int indexHint)

Tries to find a layer with LINK_LAYER_NAME in the IlvMapLayerTreeModel of the manager.

Parameters:

manager - The manager to create the map layer for.

indexHint - the index set through CSS for a type of links.

Returns:

The map layer found or null.

Since:

JViews 8.5

getSymbolMapLayer

public IlvMapLayer getSymbolMapLayer(IlvManager manager)

Tries to find a layer with SYMBOL_LAYER_NAME in the IlvMapLayerTreeModel of the manager.

Parameters:

manager - The manager to create the map layer for.

Returns:

The map layer found or null.

Since:

JViews 8.1

getSymbolMapLayer

public IlvMapLayer getSymbolMapLayer(IlvManager manager,
                                     int indexHint)

Tries to find a layer with getSymbolLayerName(int) in the IlvMapLayerTreeModel of the manager.

Parameters:

manager - The manager to create the map layer for.

indexHint - the index specified through CSS for a type of symbol.

Returns:

The map layer found or null.

Since:

JViews 8.5

createSymbolMapLayer

protected IlvMapLayer createSymbolMapLayer(IlvManager manager)

Creates the symbol layer and adds a listener that will remove all symbols if the layer is removed.

Parameters:

manager - The manager used to add the symbol layer into the IlvMapLayerTreeModel of the manager.

Returns:

A new symbol layer.

Since:

JViews 8.1

createSymbolMapLayer

protected IlvMapLayer createSymbolMapLayer(IlvManager manager,
                                           int indexHint)

Creates the symbol layer and adds a listener that will remove all symbols if the layer is removed.

Parameters:

manager - The manager used to add the symbol layer into the IlvMapLayerTreeModel of the manager.

indexHint - the index specified through CSS for a type of symbol.

Returns:

A new symbol layer.

Since:

JViews 8.5

See Also:

getSymbolLayerName(int)

getSymbolLayerName

protected String getSymbolLayerName(int indexHint)

Returns the symbol layer name for that SDM index. The default implementation will return SYMBOL_LAYER_NAME when the hint is unspecified or will concatenate the index if it is set.

Parameters:

indexHint - the index specified through CSS for a type of symbol.

Returns:

the symbol layer name.

Since:

JViews 8.5

createLinkMapLayer

protected IlvMapLayer createLinkMapLayer(IlvManager manager)

Creates a link layer and adds a listener that will remove all symbols if the layer is removed.

Parameters:

manager - The manager used to add the symbol layer into the IlvMapLayerTreeModel of the manager.

Returns:

A new symbol layer.

Since:

JViews 8.1

createLinkMapLayer

protected IlvMapLayer createLinkMapLayer(IlvManager manager,
                                         int indexHint)

Creates a link layer and adds a listener that will remove all symbols if the layer is removed.

Parameters:

manager - The manager used to add the symbol layer into the IlvMapLayerTreeModel of the manager.

indexHint - the index specified through CSS for a type of link.

Returns:

A new symbol layer.

Since:

JViews 8.5

getLinkLayerName

protected String getLinkLayerName(int indexHint)

Returns the link layer name for that SDM index. The default implementation will return LINK_LAYER_NAME when the hint is unspecified or will concatenate the index if it is set.

Parameters:

indexHint - the index specified through CSS for a type of link.

Returns:

the link layer name.

Since:

JViews 8.5

customizeLayers

protected void customizeLayers(IlvSDMEngine engine,
                               Object node,
                               IlvGraphic g,
                               String[] pseudoClass)

Changes the layer of the graphic object if needed. The method is overridden to do nothing.

Overrides:

customizeLayers in class IlvStyleSheetRenderer

Parameters:

engine - The engine.

node - The node.

g - The graphic object.

pseudoClass - the pseudo classes.

Since:

JViews 8.6

Internal: do not use!

addNodeGraphic

public void addNodeGraphic(IlvSDMEngine engine,
                           Object node,
                           IlvGraphic graphic,
                           boolean redraw)

Creates a new symbol map layer if one does not already exist. This method also sets its manager layer as the one to place symbols into.

Overrides:

addNodeGraphic in class IlvStyleSheetRenderer

Parameters:

engine - The rendering engine.

node - The symbol to add to the layer.

graphic - The graphic to add.

redraw - Set to true to redraw.

See Also:

IlvStyleSheetRenderer.addNodeGraphic(ilog.views.sdm.IlvSDMEngine, java.lang.Object, ilog.views.IlvGraphic, boolean)

addLinkGraphic

public void addLinkGraphic(IlvSDMEngine engine,
                           Object node,
                           IlvGraphic graphic,
                           boolean redraw)

Creates a new link map layer if one does not already exist. This method also sets its manager layer as the one to place links into.

Overrides:

addLinkGraphic in class IlvStyleSheetRenderer

Parameters:

engine - The rendering engine.

node - The link to add to the layer.

graphic - The graphic to add.

redraw - Set to true to redraw.

See Also:

IlvStyleSheetRenderer.addLinkGraphic(ilog.views.sdm.IlvSDMEngine, java.lang.Object, ilog.views.IlvGraphic, boolean)