ilog.views.maps.labelling
Class IlvMapLayoutParameters

java.lang.Object
  ilog.views.maps.labelling.IlvMapLayoutParameters

public class IlvMapLayoutParameters
extends Object

A class to store ILOG JViews Maps label layout parameters.

Since:

JViews 5.0

Constructor Summary

IlvMapLayoutParameters()
Creates an IlvMapLayoutParameters.

Method Summary

float	getDistFromOtherObstacles() Retrieves the distance from the other obstacles.
float	getHalfPathHeight() Retrieves the half path height.
float	getHalfPathWidth() Retrieves the half path width.
float	getLabelOffset() Retrieves the label offset.
float	getMaxDistFromPath() Retrieves the max dist from path.
float	getObstacleOffset() Retrieves the obstacle offset.
int	getObstacleShape() Retrieves the obstacle shape.
static IlvMapLayoutParameters	GetParameters(IlvManager manager) Constructs an IlvMapLayoutParameters from the properties attached to an IlvManager.
int	getPreferredDirection() Retrieves the preferred direction.
float	getPreferredDistFromPath() Retrieves the preferred dist from path.
boolean	isUsingGraphicReference() Tells if the labeler is using the IlvGraphic reference of the IlvAnchoredLabel as an obstacle or as a point.
static void	PutParameters(IlvManager manager, IlvMapLayoutParameters parameters) Attaches the parameters to a manager.
void	setDistFromOtherObstacles(float d) Set the distance from the other obstacles.
void	setHalfPathHeight(float h) Sets the half path height.
void	setHalfPathWidth(float w) Sets the half path width.
void	setLabelOffset(float o) Sets the label offset.
void	setMaxDistFromPath(float m) Set the max dist from path.
void	setObstacleOffset(float o) Sets the obstacle offset.
void	setObstacleShape(int s) Sets the obstacle shape.
void	setPreferredDirection(int d) Sets the preferred direction.
void	setPreferredDistFromPath(float p) Set the preferred dist from path.
void	setUsingGraphicReference(boolean use) Tells the labeler if it should use the IlvGraphic reference of the IlvAnchoredLabel reference as an obstacle or as a point.
String	toString() Pretty string representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvMapLayoutParameters

public IlvMapLayoutParameters()

Creates an IlvMapLayoutParameters. The default values are the following ones :

• LabelOffset = 1f
• ObstacleOffset = 1f
• HalfPathWidth = 1f
• HalfPathHeight = 1f
• MaxDistFromPath = 30f
• PreferredDistFromPath = 1f
• DistFromOtherObstacles = 1f
• PreferredDirection = IlvDirection.Top
• UsingGraphicReference = true
• ObstacleShape = IlvAnnealingPointLabelDescriptor.RECTANGULAR

Method Detail

getLabelOffset

public float getLabelOffset()

Retrieves the label offset.

setLabelOffset

public void setLabelOffset(float o)

Sets the label offset.

See Also:

IlvAnnealingLabelLayout.setLabelOffset(float)

getObstacleOffset

public float getObstacleOffset()

Retrieves the obstacle offset.

setObstacleOffset

public void setObstacleOffset(float o)

Sets the obstacle offset.

See Also:

IlvAnnealingLabelLayout.setObstacleOffset(float)

getHalfPathWidth

public float getHalfPathWidth()

Retrieves the half path width.

setHalfPathWidth

public void setHalfPathWidth(float w)

Sets the half path width.

See Also:

IlvAnnealingPointLabelDescriptor.setHalfWidth(float)

getHalfPathHeight

public float getHalfPathHeight()

Retrieves the half path height.

setHalfPathHeight

public void setHalfPathHeight(float h)

Sets the half path height.

See Also:

IlvAnnealingPointLabelDescriptor.setHalfHeight(float)

getMaxDistFromPath

public float getMaxDistFromPath()

Retrieves the max dist from path.

setMaxDistFromPath

public void setMaxDistFromPath(float m)

Set the max dist from path.

See Also:

IlvAnnealingPointLabelDescriptor.setMaxDistFromPath(float)

getPreferredDistFromPath

public float getPreferredDistFromPath()

Retrieves the preferred dist from path.

setPreferredDistFromPath

public void setPreferredDistFromPath(float p)

Set the preferred dist from path.

See Also:

IlvAnnealingPointLabelDescriptor.setPreferredDistFromPath(float)

getDistFromOtherObstacles

public float getDistFromOtherObstacles()

Retrieves the distance from the other obstacles.

setDistFromOtherObstacles

public void setDistFromOtherObstacles(float d)

Set the distance from the other obstacles.

getPreferredDirection

public int getPreferredDirection()

Retrieves the preferred direction.

setPreferredDirection

public void setPreferredDirection(int d)

Sets the preferred direction. Possible directions are: IlvDirection.Left IlvDirection.Right IlvDirection.Top IlvDirection.Bottom

See Also:

IlvAnnealingPointLabelDescriptor.setPreferredDirection(int)

getObstacleShape

public int getObstacleShape()

Retrieves the obstacle shape.

setObstacleShape

public void setObstacleShape(int s)

Sets the obstacle shape.

See Also:

IlvAnnealingPointLabelDescriptor.setShape(int)

setUsingGraphicReference

public void setUsingGraphicReference(boolean use)

Tells the labeler if it should use the IlvGraphic reference of the IlvAnchoredLabel reference as an obstacle or as a point.

See Also:

IlvAnchoredLabel.getReference(), IlvAnchoredLabel.getReferencePoint()

isUsingGraphicReference

public boolean isUsingGraphicReference()

Tells if the labeler is using the IlvGraphic reference of the IlvAnchoredLabel as an obstacle or as a point.

toString

public String toString()

Pretty string representation.

Overrides:

toString in class Object

PutParameters

public static void PutParameters(IlvManager manager,
                                 IlvMapLayoutParameters parameters)

Attaches the parameters to a manager.

Parameters:

manager - The manager.

parameters - The parameters to attach.

GetParameters

public static IlvMapLayoutParameters GetParameters(IlvManager manager)

Constructs an IlvMapLayoutParameters from the properties attached to an IlvManager. If no properties have been set, an IlvMapLayoutParameters with default values is returned.