ilog.tgo.graphic.graphlayout.labellayout

Class IltLabelingModel

java.lang.Object

ilog.views.graphlayout.labellayout.IlvLabelingModel

ilog.views.graphlayout.labellayout.IlvDefaultLabelingModel

ilog.tgo.graphic.graphlayout.labellayout.IltLabelingModel

All Implemented Interfaces:

IlvLabelingModelWithRotation

public class IltLabelingModel
extends IlvDefaultLabelingModel

An IltLabelingModel provides a default labeling model for an IltCompositeGrapher and provides a bridge between the API of the IltCompositeGrapher and the API of the IlvLabelingModel.

Since:

JTGO 3.0

Constructor Summary

Constructors

Constructor and Description
IltLabelingModel(IltCompositeGrapher grapher) Constructor.

Method Summary

Modifier and Type	Method and Description
IlvRect	boundingBox(Object labelOrObstacle) Returns the bounding rectangle of a label or obstacle.
void	build(IltAnnealingLabelLayout layout)
IlvLabelingModel	createLabelingModel(Object subgraph) Creates a new IlvDefaultLabelingModel for a subgraph.
IltCompositeGrapher	getGrapher() Returns the IltCompositeGrapher which this model applies to.
Enumeration<ilog.tgo.graphic.graphlayout.labellayout.IltLabel>	getLabels() Returns the enumeration of all labels.
Enumeration<ilog.tgo.graphic.graphlayout.labellayout.IltObstacle>	getObstacles() Returns the enumeration of all obstacles.
IlvPoint[]	getPolylinePoints(Object polylineObstacle) Returns the points that define the shape of a polyline obstacle.
double	getPolylineWidth(Object polylineObstacle) Returns the line width of a polyline obstacle.
Object	getProperty(Object labelOrObstacle, String key) Returns the value of a property.
boolean	isLabel(Object obj) Returns true if an object is a valid label and false otherwise.
boolean	isObstacle(Object obj) Returns true if an object is a valid obstacle and false otherwise.
boolean	isPolylineObstacle(Object obj) Returns true if an object is a valid polyline obstacle and false otherwise.
void	moveLabel(Object label, double x, double y, boolean redraw) Changes the position of the specified label.
void	setProperty(Object labelOrObstacle, String key, Object value) Sets the value of a property for a label or an obstacle.
void	updateLabelPosition(IlvAnnealingLabelLayout labelLayout, IltCompositeGraphic cg)

Methods inherited from class ilog.views.graphlayout.labellayout.IlvDefaultLabelingModel

addLayer, afterLayout, beforeLayout, dispose, getCoordinatesMode, getLabelOverlap, getLabelOverlap, getLayers, getLayersCount, getManager, getObstacleOverlap, getObstacleOverlap, getPolylineObstacleOverlap, getPolylineObstacleOverlap, getProperty, getReferenceTransformer, getReferenceView, getRotation, isBoundingBoxDependent, isDefaultLabelClass, isDefaultObstacleClass, isFullLayerNotification, isLayerAdded, isLayoutNeeded, loadParametersFromNamedProperties, loadParametersFromNamedProperties, loadParametersFromNamedProperties, removeAllLayers, removeLayer, removeParametersFromNamedProperties, removeParametersFromNamedProperties, removeParametersFromNamedProperties, saveParametersToNamedProperties, saveParametersToNamedProperties, setCoordinatesMode, setFullLayerNotification, setLabel, setObstacle, setProperty, setReferenceTransformer, setReferenceView, setRotation, toString

Methods inherited from class ilog.views.graphlayout.labellayout.IlvLabelingModel

addLabelingModelListener, adjustmentEnd, afterAttach, afterDetach, fireLabelingModelEvent, fireLabelingModelEvent, geometryChanged, getInstanceId, getLabelsCount, getObstaclesCount, removeLabelingModelListener, structureChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

IltLabelingModel

public IltLabelingModel(IltCompositeGrapher grapher)

Constructor.

Parameters:

grapher - The IltCompositeGrapher

Method Detail

getGrapher

public IltCompositeGrapher getGrapher()

Returns the IltCompositeGrapher which this model applies to.

Returns:

The IltCompositeGrapher

createLabelingModel

public IlvLabelingModel createLabelingModel(Object subgraph)

Description copied from class: IlvDefaultLabelingModel

Creates a new IlvDefaultLabelingModel for a subgraph. The method is used when performing a layout of nested graphs that contain labels. It is called on the labeling model of a top-level graph that contains the subgraph.

Overrides:

createLabelingModel in class IlvDefaultLabelingModel

Parameters:

subgraph - The subgraph object. It must be an instance of IlvManager.

Returns:

Always null

getLabels

public Enumeration<ilog.tgo.graphic.graphlayout.labellayout.IltLabel> getLabels()

Description copied from class: IlvDefaultLabelingModel

Returns the enumeration of all labels.

Overrides:

getLabels in class IlvDefaultLabelingModel

See Also:

IlvLabelingModel.getLabelsCount()

isLabel

public boolean isLabel(Object obj)

Description copied from class: IlvDefaultLabelingModel

Returns true if an object is a valid label and false otherwise. It returns true if the object was specified as a label via IlvDefaultLabelingModel.setLabel(java.lang.Object, boolean), and false if the object was explicitly specified not to be a label. If nothing was specified via IlvDefaultLabelingModel.setLabel(java.lang.Object, boolean), this method also returns true if the object is an IlvLabel, an IlvZoomableLabel or an IlvText.

If layers were selected for layout (see IlvDefaultLabelingModel.addLayer(ilog.views.IlvManagerLayer)), then it returns false if the object is in a layer that is currently not selected for layout, independent of its type.

If you want to change the default behavior to consider different classes as labels, you should not override this method but rather override IlvDefaultLabelingModel.isDefaultLabelClass(java.lang.Object).

Overrides:

isLabel in class IlvDefaultLabelingModel

Parameters:

obj - The object to test.

Returns:

true if an object is a valid label.

moveLabel

public void moveLabel(Object label,
                      double x,
                      double y,
                      boolean redraw)

Description copied from class: IlvDefaultLabelingModel

Changes the position of the specified label. The x and y coordinates correspond to the top-left corner of the rectangle that defines the label (see also the method IlvDefaultLabelingModel.boundingBox(Object)). The coordinates are given with respect to the current coordinates mode.

Overrides:

moveLabel in class IlvDefaultLabelingModel

Parameters:

label - The label.

x - The new x-position of the label.

y - The new y-position of the label.

redraw - If true, the label is redrawn.

See Also:

IlvDefaultLabelingModel.setCoordinatesMode(int)

getObstacles

public Enumeration<ilog.tgo.graphic.graphlayout.labellayout.IltObstacle> getObstacles()

Description copied from class: IlvDefaultLabelingModel

Returns the enumeration of all obstacles.

Overrides:

getObstacles in class IlvDefaultLabelingModel

See Also:

IlvLabelingModel.getObstaclesCount()

isObstacle

public boolean isObstacle(Object obj)

Description copied from class: IlvDefaultLabelingModel

Returns true if an object is a valid obstacle and false otherwise. It returns true if the object was specified as obstacle via IlvDefaultLabelingModel.setObstacle(java.lang.Object, boolean), and false if the object was explicitly specified to not be an obstacle. If nothing was specified via IlvDefaultLabelingModel.setObstacle(java.lang.Object, boolean), this method also returns true if the object is not an IlvLabel or an IlvZoomableLabel or an IlvText.

If layers were selected for layout (see IlvDefaultLabelingModel.addLayer(ilog.views.IlvManagerLayer)), then it returns false if the object is in a layer that is currently not selected for layout, independent of its type.

If you want to change the default behavior to consider different classes as obstacles, you should not override this method but rather override IlvDefaultLabelingModel.isDefaultObstacleClass(java.lang.Object).

Overrides:

isObstacle in class IlvDefaultLabelingModel

Parameters:

obj - The object to test.

Returns:

true if an object is a valid obstacle.

See Also:

IlvLabelingModel.isPolylineObstacle(java.lang.Object)

boundingBox

public IlvRect boundingBox(Object labelOrObstacle)

Description copied from class: IlvDefaultLabelingModel

Returns the bounding rectangle of a label or obstacle. The returned rectangle depends on the current coordinates mode:

• IlvLabelLayout.MANAGER_COORDINATES: returns the bounding box of the graphic object in the coordinate space of the manager, that is, it calls IlvGraphic.boundingBox(IlvTransformer) with a null argument.
• IlvLabelLayout.VIEW_COORDINATES: returns the bounding box of the graphic object in the coordinate space of the view, that is, it calls IlvGraphic.boundingBox(IlvTransformer) with the reference transformer as an argument (see IlvDefaultLabelingModel.getReferenceTransformer()).
• IlvLabelLayout.INVERSE_VIEW_COORDINATES: returns the bounding box of the graphic object by calculating the bounding box in the coordinate space of the view and applying to the rectangle the inverse transformation (using the reference transformer) to obtain the corresponding rectangle in the coordinate space of the manager. This complex mechanism is necessary if the object is not fully zoomable.

Overrides:

boundingBox in class IlvDefaultLabelingModel

Parameters:

labelOrObstacle - The label or obstacle.

Returns:

The bounding rectangle of the input object.

isPolylineObstacle

public boolean isPolylineObstacle(Object obj)

Description copied from class: IlvDefaultLabelingModel

Returns true if an object is a valid polyline obstacle and false otherwise.

The default implementation returns true if the object is an obstacle of one of these types:

• IlvLinkImage
• IlvLine
• IlvPolyline

If layers were selected for layout (see IlvDefaultLabelingModel.addLayer(ilog.views.IlvManagerLayer)), then it returns false if the object is in a layer that is currently not selected for layout, independent of its type.

Overrides:

isPolylineObstacle in class IlvDefaultLabelingModel

Parameters:

obj - The object to test.

Returns:

true if the object is a polyline obstacle.

See Also:

IlvDefaultLabelingModel.isObstacle(java.lang.Object)

getPolylineWidth

public double getPolylineWidth(Object polylineObstacle)

Description copied from class: IlvDefaultLabelingModel

Returns the line width of a polyline obstacle. The returned width depends on the current coordinates mode:

• IlvLabelLayout.MANAGER_COORDINATES: returns the width of the polyline obstacle in the coordinate space of the manager.
• IlvLabelLayout.VIEW_COORDINATES: returns the width of the polyline obstacle in the coordinate space of the view (see IlvDefaultLabelingModel.getReferenceTransformer()).
• IlvLabelLayout.INVERSE_VIEW_COORDINATES: returns the width of the polyline obstacle by calculating the width in the coordinate space of the view and applying the inverse transformation (using the reference transformer) to obtain the corresponding value in the coordinate space of the manager. This complex mechanism is necessary if the obstacle is not fully zoomable.

Overrides:

getPolylineWidth in class IlvDefaultLabelingModel

Parameters:

polylineObstacle - The polyline obstacle.

Returns:

The line width, a positive value.

See Also:

IlvDefaultLabelingModel.isPolylineObstacle(java.lang.Object), IlvGraphic.zoomable()

getPolylinePoints

public IlvPoint[] getPolylinePoints(Object polylineObstacle)

Description copied from class: IlvDefaultLabelingModel

Returns the points that define the shape of a polyline obstacle. The returned points depends on the current coordinates mode:

• IlvLabelLayout.MANAGER_COORDINATES: returns the points in the coordinate space of the manager.
• IlvLabelLayout.VIEW_COORDINATES: returns the points in the coordinate space of the view (see IlvDefaultLabelingModel.getReferenceTransformer()).
• IlvLabelLayout.INVERSE_VIEW_COORDINATES: returns the points by calculating the points in the coordinate space of the view and applying the inverse transformation to the points (using the reference transformer) to obtain the corresponding points in the coordinate space of the manager. This complex mechanism is necessary if the obstacle is not fully zoomable.

Overrides:

getPolylinePoints in class IlvDefaultLabelingModel

Parameters:

polylineObstacle - The polyline obstacle.

Returns:

The points of the polyline, including the start and end points, or null if the points cannot be determined.

See Also:

IlvDefaultLabelingModel.isPolylineObstacle(java.lang.Object), IlvGraphic.zoomable()

setProperty

public void setProperty(Object labelOrObstacle,
                        String key,
                        Object value)

Description copied from class: IlvDefaultLabelingModel

Sets the value of a property for a label or an obstacle. If value is null, the property is removed. Otherwise, the property value is set to value.

Overrides:

setProperty in class IlvDefaultLabelingModel

Parameters:

labelOrObstacle - The label or obstacle for which the property is to be set.

key - The key string for the property.

value - The new value of the property.

See Also:

IlvDefaultLabelingModel.getProperty(java.lang.Object, java.lang.String)

getProperty

public Object getProperty(Object labelOrObstacle,
                          String key)

Description copied from class: IlvDefaultLabelingModel

Returns the value of a property. The method returns null if the property does not exist.

Overrides:

getProperty in class IlvDefaultLabelingModel

Parameters:

labelOrObstacle - The label or obstacle for which the property is to be retrieved.

key - The key string for the property.

Returns:

The value of the property.

See Also:

IlvDefaultLabelingModel.setProperty(java.lang.Object, java.lang.String, java.lang.Object)

build

public void build(IltAnnealingLabelLayout layout)

Internal: do not use!

updateLabelPosition

public void updateLabelPosition(IlvAnnealingLabelLayout labelLayout,
                                IltCompositeGraphic cg)

Internal: do not use!