ilog.tgo.model

Class IltAbstractLink

java.lang.Object

ilog.cpl.model.IlpDefaultObject

ilog.tgo.model.IltObject

ilog.tgo.model.IltAbstractLink

All Implemented Interfaces:

IlpAttributeValueHolder, IlpObject, IltStateHolder, ilog.tgo.model.state.event.IltObjectStateListener, IltWithProperties, IlWithProperties, EventListener

Direct Known Subclasses:

IltLink, IltLinkBundle, IltLinkSet

public abstract class IltAbstractLink
extends IltObject

This class models any kind of link, either with or without a graphic rendering.

Nested Class Summary

Nested classes/interfaces inherited from class ilog.tgo.model.IltObject

IltObject.ListPrimaryStateStyleValueProvider, IltObject.LogicalType, IltObject.TinyType

Field Summary

Fields

Modifier and Type	Field and Description
static float	DefaultLinkDistance This class variable stores the default distance between two parallel links.
static IlpEnumKey	FromPort Deprecated. Please use CSS property fromPort instead.
static IltAttribute	FromPortAttribute fromPort attribute.
static IlpColorKey	InnerBackgroundColor Deprecated.
static IlpFloatKey	InnerBorderWidth Deprecated.
static IlpFloatKey	InnerCenterWidth Deprecated.
static IlpColorKey	InnerForegroundColor Deprecated.
static IlpLineStyleKey	InnerLineStyle Deprecated.
static IltObjectInfo	metainfo Contains metainformation about this IltObject class.
protected PropertyChangeSupport	propSupport
static IlpEnumKey	ToPort Deprecated. Please use CSS property toPort instead.
static IltAttribute	ToPortAttribute toPort attribute.

Fields inherited from class ilog.tgo.model.IltObject

_automaticDecorationsDirection, _cloneConstructor, AbbreviateBalloonAlarmCount, AbbreviateBaseAlarmCount, AckAlarmHighestSeverityAttribute, AckImpactAlarmHighestSeverityAttribute, AlarmBalloonColor, AlarmBalloonContentsCollapsed, AlarmBalloonCountIcon, AlarmBalloonCountLabel, AlarmBalloonPosition, AlarmBalloonShadowColor, AlarmBalloonTextAntialiasing, AlarmBalloonTextBackgroundColor, AlarmBalloonTextFont, AlarmBalloonTextForegroundColor, AlarmBalloonVisible, AlarmBorderColor, AlarmBorderThickness, AlarmBorderVisible, AlarmBrightColor, AlarmColor, AlarmColorLevel, AlarmColorVisible, AlarmCountAntialiasing, AlarmCountAttribute, AlarmCountBackgroundColor, AlarmCountFont, AlarmCountForegroundColor, AlarmCountIcon, AlarmCountIconPosition, AlarmCountIconVisible, AlarmCountLabel, AlarmCountNumberAttribute, AlarmCountVisible, AlarmCriticalAbbreviation, AlarmCriticalBrightColor, AlarmCriticalColor, AlarmCriticalDarkColor, AlarmCriticalDescription, AlarmDarkColor, AlarmHighestSeverityAttribute, AlarmLossOfConnectivityAbbreviation, AlarmLossOfConnectivityBrightColor, AlarmLossOfConnectivityColor, AlarmLossOfConnectivityDarkColor, AlarmLossOfConnectivityOverride, AlarmMajorAbbreviation, AlarmMajorBrightColor, AlarmMajorColor, AlarmMajorDarkColor, AlarmMajorDescription, AlarmMinorAbbreviation, AlarmMinorBrightColor, AlarmMinorColor, AlarmMinorDarkColor, AlarmMinorDescription, AlarmNotReportingAbbreviation, AlarmsAsMarks, AlarmSeverityColorMap, AlarmSeverityDescriptionMap, AlarmUnknownAbbreviation, AlarmUnknownBrightColor, AlarmUnknownColor, AlarmUnknownDarkColor, AlarmUnknownDescription, AlarmWarningAbbreviation, AlarmWarningBrightColor, AlarmWarningColor, AlarmWarningDarkColor, AlarmWarningDescription, Alpha, BackgroundColor, BaseSelectionBorderVisible, BaseStyleEnabled, BlinkingBackgroundColor, BlinkingBorderColor, BlinkingBorderColor2, BlinkingForegroundColor, BorderColor, BorderColor2, BorderLineStyle, BorderPattern, BorderWidth, BUSINESS_OBJECT_PROPERTY, CanBeLogical, CenterWidth, ChildrenDecorationConstraints, ChildrenDecorations, ContainerCollapseIconVisible, ContainerExpansionIconVisible, ContainerOutsideExpansionIconVisible, ContainerStatusVisible, DetailLevel, Direction, DottedBorderBackgroundColor, DottedBorderForegroundColor, DottedBorderLineStyle, ForcedWidth, ForegroundColor, GraphicRepresentationAttribute, HasAlarmColor, IconsVisible, ImpactAlarmCountAttribute, ImpactAlarmCountNumberAttribute, ImpactAlarmHighestSeverityAttribute, InfoIconInteractor, InfoIconThreshold, InfoWindowAlwaysVisible, InfoWindowBorderColor, InfoWindowColor, InfoWindowShadowColor, InfoWindowTextAntialiasing, InfoWindowTextBackgroundColor, InfoWindowTextFont, InfoWindowTextForegroundColor, InfoWindowVisible, IsEditable, IsLogical, IsSelectable, IsTiny, IsVisible, LabelAntialiasing, LabelBackgroundColor, LabelBorderColor, LabelDirection, LabelFont, LabelForegroundColor, LabelOffset, LabelPosition, LabelVisible, LabelZoomable, LineStyle, LinkPorts, ListAlarmStateAbbreviated, ListPrimaryAlarmState, ListPrimaryState, ListSecondaryAlarmState, LogicalBorderThickness, LogicalHeight, LogicalLabelAntialiasing, LogicalLabelFont, LogicalTypeAttribute, LogicalWidth, MappedBorderColor, MappedBorderColor2, MappedBrightColor, MappedColor, MappedColor2, MappedDarkColor, MultilineBaseAlarmCount, NameAttribute, NewAlarmCountAttribute, NewAlarmCountNumberAttribute, NewAlarmHighestSeverityAttribute, NewImpactAlarmCountAttribute, NewImpactAlarmCountNumberAttribute, NewImpactAlarmHighestSeverityAttribute, ObjectStateAttribute, PassiveIcon, PassiveIconVisible, Pattern, PlinthBrightColor, PlinthColor, PlinthDarkColor, PlinthHorizontalMargin, PlinthVerticalMargin, PlinthVisible, PositionAttribute, PrimaryAlarmState, PrimaryStateAttribute, ReliefBorders, SecondaryStatesAttribute, SecondaryStateStackerPosition, SelectionBorderBackgroundColor, SelectionBorderForegroundColor, SelectionBorderLineStyle, SelectionBorderThickness, ShortcutIcon, ShortcutIconMap, ShortcutIconVisible, ShortcutToolTipMap, SNMPSystemContact, SNMPSystemDescription, SNMPSystemLocation, SourceImage, TinyAlarmBorderThickness, TinyBorderThickness, TinyLabelAntialiasing, TinyLabelFont, TinyTypeAttribute, TrapAuthenticationFailureAbbreviation, TrapAuthenticationFailureBrightColor, TrapAuthenticationFailureColor, TrapAuthenticationFailureDarkColor, TrapAuthenticationFailureDescription, TrapColdStartAbbreviation, TrapColdStartBrightColor, TrapColdStartColor, TrapColdStartDarkColor, TrapColdStartDescription, TrapEGPNeighborLossAbbreviation, TrapEGPNeighborLossBrightColor, TrapEGPNeighborLossColor, TrapEGPNeighborLossDarkColor, TrapEGPNeighborLossDescription, TrapLinkFailureAbbreviation, TrapLinkFailureBrightColor, TrapLinkFailureColor, TrapLinkFailureDarkColor, TrapLinkFailureDescription, TrapWarmStartAbbreviation, TrapWarmStartBrightColor, TrapWarmStartColor, TrapWarmStartDarkColor, TrapWarmStartDescription

Fields inherited from interface ilog.cpl.model.IlpAttributeValueHolder

VALUE_NOT_SET

Constructor Summary

Constructors

Constructor and Description
IltAbstractLink(IlpClass ilpClass, Object identifier) Initializes the IltAbstractLink part of a link instance.
IltAbstractLink(IltObjectState state, String label) Initializes the IltAbstractLink part of a link instance.
IltAbstractLink(Object identifier) Initializes the IltAbstractLink part of a link instance.

Method Summary

Modifier and Type	Method and Description
IltLinkSet	_getLinkSet() If the link has been added to a link set, this method returns the instance of IltLinkSet that implements the link set, regardless of whether the link set implements a bundle or not.
void	_setLinkSet(IltLinkSet linkSet) Sets the link set the link is in.
void	addPropertyChangeListener(PropertyChangeListener listener) Add a PropertyChangeListener to the listener list.
void	applyTransform(IltGraphicManager manager, IltGraphic graphic, IlvTransformer t, IlpPositionSource reason) Deprecated.
protected void	copyFrom(IltAbstractLink other) Support for renderer.
ilog.tgo.graphic.internal.IltGraphicUpdate	createPositionUpdate(Object position, Object positionInManager) Creates the graphic update responsible for setting the position/shape to a graphical representation.
static void	ForceInit(ilog.tgo.util.internal.IltForceClassInit object) To deserialize IltClassLegend instances.
protected void	forgetShapeGraphicSettingInManager(IltGraphicManager manager, IltGraphic graphic) Removes the shape graphic setting in manager coordinates.
IlvRect	getBaseRectangle(IltGraphicManager manager) Returns the base rectangle of the graphic representation in a given IltGraphicManager.
protected IlvPoint	getCenterPoint(IltGraphicManager manager, IltGraphic graphic) Returns the position of the graphic representation in a given IltcObjectContainer.
static IltLegend	GetClassLegend() Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism. Please refer to the User's Manual for further information.
IltAbstractLink	getDelegateFromTo()
IltObject	getFrom() Returns the object that is used as the logical first extremity of the link.
IltObject	getFrom(IltGraphic graphic) Returns the object used as the first extremity of the given graphic representation of the link.
IltObject	getFrom(IltGraphicManager manager) Returns the first extremity of the link in the given manager, or getLogicalFrom if the link is not in the manager.
ilog.tgo.graphic.internal.IltGraphicRepresentationStyle	getGraphicRepresentationStyle(IltCompositeGraphic graphic) Returns the graphic representation type that should be used to the given composite graphic in this moment.
static IltObjectInfo	GetIlpClass() Returns the IlpClass corresponding to this Java class.
IltLinkSet	getLinkSet() If the link has been added to a link set, this method returns the instance of IltLinkSet that implements the link set.
IltObject	getLogicalFrom() This method is identical to getFrom.
IltObject	getLogicalTo() This method is identical to getTo.
IltObject	getNextFrom(IltGraphicManager manager) Returns the object that will be used as the first extremity of the link, the next time the link is added to a manager.
IltObject	getNextTo(IltGraphicManager manager) Returns the object that will be used as the second extremity of the link, the next time the link is added to a manager.
IltGraphic	getOutermostParentGraphic(IltGraphicManager manager) This method is overridden by the subclasses which can be contained in other IltObjects.
IltLineSpec	getRepresentation() Returns the graphic representation of the link, if fixed.
IlpPolyline	getShape(IltGraphicManager manager) Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation visible. When working with datasource, please use getPosition instead.
protected IlpPolyline	getShape(IltGraphicManager manager, IltGraphic graphic) Returns the shape graphic setting.
IlpPolyline	getShapeInManager(IltGraphic graphic) For convenience, since the above does not really depend on the manager.
protected IlpPolyline	getShapeInManager(IltGraphicManager manager, IltGraphic graphic) Returns the position of the graphic representation in a given IltGraphicManager.
IltObject	getTo() Returns the object that is used as the logical second extremity of the link.
IltObject	getTo(IltGraphic graphic) Returns the object used as the second extremity of the given graphic representation of the link.
IltObject	getTo(IltGraphicManager manager) Returns the second extremity of the link in the given manager, or getLogicalTo if the link is not in the manager.
double	getWidth(IltGraphicManager manager) Deprecated.
abstract double	getWidth(IltGraphicManager manager, IltGraphic graphic) Returns the width of the graphic representation.
void	initializeVisibleGraphic(IltGraphicManager manager, IltGraphic graphic) This is called before adding a graphic representation to a given view.
boolean	isValidPosition(Object position) Determines whether the argument is a valid position/shape for this type of object.
void	postCreateGraphic(IltGraphicManager manager, IltGraphic graphic) This is called at the end of adding a graphic representation to a given view.
void	removeGraphic(IltGraphicManager manager) Removes the graphic representation of this link from the given manager.
void	removePropertyChangeListener(PropertyChangeListener listener) Remove a PropertyChangeListener from the listener list.
void	restoreVisibility(IltGraphicManager manager, IltGraphicSettings settings) Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation visible. Once visible, it is updated automatically when needed.
void	setBaseRectangle(IltGraphicManager manager, IlvRect newBaseRectangle) Applies a transformation to the graphic representation in a given IltGraphicManager, attempting to make the base rectangle resemble the given rectangle.
void	setCenterPoint(IltGraphicManager manager, IltGraphic graphic, IlvPoint position, IlpPositionSource reason) Changes the position of the graphic representation in a given IltcObjectContainer.
void	setFrom(IltGraphicManager manager, IltObject from) Sets the object that is to use as the first extremity of the link in the given manager.
void	setFrom(IltObject from) Sets the object that is used as the logical first extremity of the link.
void	setFromOverride(IltGraphicManager manager, IltObject newEnd) Changes the override setting for the "from" end of a (yet nonexistent) graphic representation.
void	setLinkLayoutProxyPresent(IltGraphicManager manager, boolean layoutable) Sets the layoutability of the link in the given manager.
void	setLogicalFrom(IltObject from) Sets the object that is used as the logical first extremity of the link.
void	setLogicalTo(IltObject to) Sets the object that is used as the logical second extremity of the link.
void	setNextFrom(IltObject nextFrom) Sets the object that will be used as the first extremity of the link the next time the link is added to a manager.
void	setNextTo(IltObject nextTo) Sets the object that will be used as the second extremity of the link the next time the link is added to a manager.
void	setShape(IltGraphicManager manager, IlpPolyline shape) Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation visible. When working with datasources, please use setPosition instead.
void	setShape(IltGraphicManager manager, IlpPolyline shape, IlpPositionSource reason) Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation visible. When working with datasources, please use setPosition instead.
void	setShape(IltGraphicManager manager, IltGraphic graphic, IlpPolyline shape, IlpPositionSource reason) Changes the shape graphic setting.
void	setShape(IltGraphicManager manager, IltLogicalPolyline shape) Deprecated. Please use IlpPolyline instead of IltLogicalPolyline.
void	setShapeGraphicSetting(IltGraphic graphic, Object newShape) Sets the graphic settings responsible for the shape of the object.
void	setShapeInManager(IltGraphicManager manager, IltGraphic graphic, IlpPolyline shape, IlpPositionSource reason, boolean assumeVisible) Changes the shape of the link in the given manager, using the provided composite graphic.
protected void	setShapeInManagerAux(IltGraphicManager manager, IltGraphic graphic, IlpPolyline shape, IlpPositionSource reason, boolean assumeVisible) Changes the position of the graphic representation in a given IltGraphicManager.
void	setShapeInManagerGraphicSetting(IltGraphic graphic, Object newShape, IlpPositionSource reason) Sets the graphic settings responsible for the shape of the object in a given manager
void	setTo(IltGraphicManager manager, IltObject to) Sets the object that is to use as the second extremity of the link in the given manager.
void	setTo(IltObject to) Sets the object that is used as the logical second extremity of the link.
void	setToOverride(IltGraphicManager manager, IltObject newEnd) Changes the override setting for the "to" end of a (yet nonexistent) graphic representation.
String	toString() Returns the String representation of this IltAbstractLink's values.
Object	transformPosition(IltGraphicManager manager, Object position) Applies the manager transformer to the position parameter.
void	updateFrom(IltObject other) Updates the local cache of attributes stored in getObjectAttribute().
void	updateShapeGraphicSettingInManager(IltGraphicManager manager, IltGraphic graphic, Object newShape, IlpPositionSource reason) If the graphic representation is visible, updates the shape graphic setting in manager coordinates.
boolean	usingDefaultShape(IltGraphicManager manager) Computes the graphic representation of the object in the given manager.

Methods inherited from class ilog.tgo.model.IltObject

__getIlpObject, addGraphicChangedListener, addStateChangedListener, applyTransform, applyTransform, applyTransform, applyTransformInManager, clearState, cloneForRendering, computeGraphic, computeGraphic, computeGraphic, computeGraphic, computeGraphic, computeGraphicAtPosition, copyFrom, createBase, createGraphic, createTinyBase, debug, defaultShape, endDelayingComputeGraphic, EndDelayingComputeGraphic, fireAllGraphicChanged, fireGraphicChanged, FromGraphic, getAlarmState, getAttacherInfo, getAttacherInfoController, getAutomaticDecorationsDirection, getBaseRectangleInManager, GetBaseStyleMapping, getCenterPoint, getCenterPointInManager, getChildren, getDefaultLabelPosition, getGraphic, getGraphic, getGraphicInHierarchy, getGraphicInteractions, getGraphicNotNull, getGraphicNotNullInHierarchy, getGraphicSetting, getGraphicSetting, getGraphicSettings, GetIltObject, getLabel, getLabelOffset, getLabelOffset, getLabelOffset, getLabelPosition, getLabelPosition, getLabelPosition, getLayoutProxy, getLegend, getLegend, getLocalStyle, getLocalStyle, getLogicalType, getMappedForUserList, getName, getObjectInfo, getObjectMapper, getObjectState, getObjectSystemMapper, getPosition, getProperty, getState, getTinyType, getTrapState, hasState, initializeCreatedGraphic, initializeDefaultValues, initializeObject, InitStyle, isEditable, isNearlyVisible, IsPropertyTransient, isSelected, isSelected, isVisible, mapDirection, mappedForUser, objectStateChanged, objectStateCleared, objectStateSet, preCreateGraphic, removeGraphic, removeGraphic, removeGraphicChangedListener, removeGraphicSetting, removeGraphicSetting, removeProperty, removeStateChangedListener, resetLabelOffset, resetLabelOffset, resetLabelPosition, resetLabelPosition, resetState, setAttributeValue, setAutomaticDecorationsDirection, setAutomaticDecorationsDirection, setBaseRectangleInManager, setCenterPoint, setCenterPoint, setCenterPointInManager, setEditable, setGraphic, setGraphicSetting, setGraphicSetting, setGraphicSetting, setGraphicSettings, setIlpClass, setLabel, setLabelOffset, setLabelOffset, setLabelPosition, setLabelPosition, setLegend, setLogicalType, setName, setObjectState, setPosition, setProperty, SetPropertyTransient, setSelected, setSelectedInternal, setState, setState, setTinyType, setVisible, startDelayingComputeGraphic, StartDelayingComputeGraphic, startVisibility

Methods inherited from class ilog.cpl.model.IlpDefaultObject

addAttributeValueListener, fireEvent, getAttributeGroup, getAttributeValue, getAttributeValue, getAttributeValueByName, getIdentifier, getIlpClass, getLocalAttributeValues, getObjectSupport, hasAttributeValue, removeAttributeValueListener, setAttributeValue, setAttributeValueByName, setLocalAttributeValues, setObjectSupport

Methods inherited from class java.lang.Object

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

Field Detail

metainfo

public static IltObjectInfo metainfo

Contains metainformation about this IltObject class.

Internal: do not use!

propSupport

protected transient PropertyChangeSupport propSupport

Internal: do not use!

DefaultLinkDistance

public static float DefaultLinkDistance

This class variable stores the default distance between two parallel links. It is used by the link layout optimizers and the link sets. The initial value of this variable is 2 pixels.

Internal: do not use!

FromPortAttribute

public static IltAttribute FromPortAttribute

fromPort attribute. This attribute allows you to specify the preferred link port at the from end. Only effective when an IltShortLinkLayout is used.

Attribute name: fromPort.

Value type: IltLinkPort.

Since:

JTGO 3.0

See Also:

IltLinkPort, IltShortLinkLayout

ToPortAttribute

public static IltAttribute ToPortAttribute

toPort attribute. This attribute allows you to specify the preferred link port at its to end. Only effective when an IltShortLinkLayout is used. Attribute name: toPort.

Value type: IltLinkPort.

Since:

JTGO 3.0

See Also:

IltLinkPort, IltShortLinkLayout

FromPort

@Deprecated
public static IlpEnumKey FromPort

Deprecated. Please use CSS property fromPort instead.

The legend property specifying the preferred link port at the from end. Only effective when an IltShortLinkLayout is used. Its value is an instance of IltLinkPort. By default, the value is an attribute style value provider pointing to the attribute FromPortAttribute.

See Also:

IltObjectCustomization.getFromPort(), IltLinkPort, IltShortLinkLayout

Deprecated Since:

JTGO 3.5

ToPort

@Deprecated
public static IlpEnumKey ToPort

Deprecated. Please use CSS property toPort instead.

The legend property specifying the preferred link port at the to end. Only effective when an IltShortLinkLayout is used. Its value is an instance of IltLinkPort. By default, the value is an attribute style value provider pointing to the attribute ToPortAttribute.

See Also:

IltObjectCustomization.getToPort(), IltLinkPort, IltShortLinkLayout

Deprecated Since:

JTGO 3.5

InnerCenterWidth

@Deprecated
public static IlpFloatKey InnerCenterWidth

Deprecated.

Internal: do not use!

InnerBorderWidth

@Deprecated
public static IlpFloatKey InnerBorderWidth

Deprecated.

Internal: do not use!

InnerLineStyle

@Deprecated
public static IlpLineStyleKey InnerLineStyle

Deprecated.

Internal: do not use!

InnerForegroundColor

@Deprecated
public static IlpColorKey InnerForegroundColor

Deprecated.

Internal: do not use!

InnerBackgroundColor

@Deprecated
public static IlpColorKey InnerBackgroundColor

Deprecated.

Internal: do not use!

Constructor Detail

IltAbstractLink

public IltAbstractLink(Object identifier)

Initializes the IltAbstractLink part of a link instance. This constructor is only here to be called by subclasses.

Parameters:

identifier - the identifier of this new instance

Since:

JTGO 3.0

IltAbstractLink

public IltAbstractLink(IlpClass ilpClass,
                       Object identifier)

Initializes the IltAbstractLink part of a link instance. This constructor is only here to be called by subclasses.

Since:

JTGO 3.0

IltAbstractLink

public IltAbstractLink(IltObjectState state,
                       String label)

Initializes the IltAbstractLink part of a link instance. This constructor is only here to be called by subclasses.

Parameters:

state - its semantic state

label - its label

Method Detail

GetIlpClass

public static IltObjectInfo GetIlpClass()

Returns the IlpClass corresponding to this Java class. Here the IlpClass interface is implemented by IltObjectInfo.
This method is used by the class manager to retrieve predefined business object classes.

Since:

JTGO 3.0

GetClassLegend

@Deprecated
public static IltLegend GetClassLegend()

Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism. Please refer to the User's Manual for further information.

Returns the business class style as defined in the default application context style manager.

Deprecated Since:

JTGO 3.0

getLinkSet

public IltLinkSet getLinkSet()

If the link has been added to a link set, this method returns the instance of IltLinkSet that implements the link set. If the link is not in a link set this method returns null.

_getLinkSet

public IltLinkSet _getLinkSet()

If the link has been added to a link set, this method returns the instance of IltLinkSet that implements the link set, regardless of whether the link set implements a bundle or not.

Internal: do not use!

_setLinkSet

public void _setLinkSet(IltLinkSet linkSet)

Sets the link set the link is in. This is not the good way of adding a link to a link set. The proper way is to use the IltLinkSet.addLink method. Note that, as opposed to TGO C++, this method does not adjust the link's layoutability; this is because the layoutability is manager-dependent.

Parameters:

linkSet - the new link set

See Also:

IltLinkSet.addLink(ilog.tgo.model.IltAbstractLink)

Internal: do not use!

getGraphicRepresentationStyle

public ilog.tgo.graphic.internal.IltGraphicRepresentationStyle getGraphicRepresentationStyle(IltCompositeGraphic graphic)

Returns the graphic representation type that should be used to the given composite graphic in this moment. This method is called by IltCompositeGraphic when the graphical representation of this object is being computed.

Overrides:

getGraphicRepresentationStyle in class IltObject

Internal: do not use!

getDelegateFromTo

public IltAbstractLink getDelegateFromTo()

Internal: do not use!

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Add a PropertyChangeListener to the listener list. The listener is registered for all properties.

Parameters:

listener - The PropertyChangeListener to be added

Since:

JTGO 3.0

Internal: do not use!

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.

Parameters:

listener - The PropertyChangeListener to be removed

Since:

JTGO 3.0

Internal: do not use!

getLogicalFrom

public IltObject getLogicalFrom()

This method is identical to getFrom.

See Also:

getFrom()

Internal: do not use!

getFrom

public IltObject getFrom()

Returns the object that is used as the logical first extremity of the link.

getLogicalTo

public IltObject getLogicalTo()

This method is identical to getTo.

See Also:

getTo()

Internal: do not use!

getTo

public IltObject getTo()

Returns the object that is used as the logical second extremity of the link.

setLogicalFrom

public void setLogicalFrom(IltObject from)

Sets the object that is used as the logical first extremity of the link. This object will be used as the first extremity of new graphic representations of the links, unless setNextFrom is used to set a specific first extremity for the link in the corresponding manager.

Internal: do not use!

setFrom

public void setFrom(IltObject from)

Sets the object that is used as the logical first extremity of the link.

setLogicalTo

public void setLogicalTo(IltObject to)

Sets the object that is used as the logical second extremity of the link. This object will be used as the second extremity of new graphic representations of the links, unless setNextTo is used to set a specific second extremity for the link in the corresponding manager.

Internal: do not use!

setTo

public void setTo(IltObject to)

Sets the object that is used as the logical second extremity of the link.

setFromOverride

public void setFromOverride(IltGraphicManager manager,
                            IltObject newEnd)

Changes the override setting for the "from" end of a (yet nonexistent) graphic representation.

Parameters:

newEnd - a telecom object or null

Internal: do not use!

setToOverride

public void setToOverride(IltGraphicManager manager,
                          IltObject newEnd)

Changes the override setting for the "to" end of a (yet nonexistent) graphic representation.

Parameters:

newEnd - a telecom object or null

Internal: do not use!

getFrom

public IltObject getFrom(IltGraphic graphic)

Returns the object used as the first extremity of the given graphic representation of the link.

Parameters:

graphic - the graphic whose from end is queried

Internal: do not use!

getTo

public IltObject getTo(IltGraphic graphic)

Returns the object used as the second extremity of the given graphic representation of the link.

Parameters:

graphic - the graphic whose to end is queried

Internal: do not use!

getFrom

public IltObject getFrom(IltGraphicManager manager)

Returns the first extremity of the link in the given manager, or getLogicalFrom if the link is not in the manager.

Parameters:

manager - the manager where to look for the link's from end

Internal: do not use!

getTo

public IltObject getTo(IltGraphicManager manager)

Returns the second extremity of the link in the given manager, or getLogicalTo if the link is not in the manager.

Parameters:

manager - the manager where to look for the link's to end

Internal: do not use!

setFrom

public void setFrom(IltGraphicManager manager,
                    IltObject from)

Sets the object that is to use as the first extremity of the link in the given manager. The link is redrawn with its new shape.

Parameters:

manager - the manager where to change the link's from end

from - the new from end of the link

Internal: do not use!

setTo

public void setTo(IltGraphicManager manager,
                  IltObject to)

Sets the object that is to use as the second extremity of the link in the given manager. The link is redrawn with its new shape.

Parameters:

manager - the manager where to change the link's to end

to - the new to end of the link

Internal: do not use!

setNextFrom

public void setNextFrom(IltObject nextFrom)

Sets the object that will be used as the first extremity of the link the next time the link is added to a manager. This value overrides the one set by calling setLogicalFrom; it is reset by the addition of the link to the manager.

See Also:

setFrom(ilog.tgo.model.IltObject)

Internal: do not use!

setNextTo

public void setNextTo(IltObject nextTo)

Sets the object that will be used as the second extremity of the link the next time the link is added to a manager. This value overrides the one set by calling setLogicalTo; it is reset by the addition of the link to the manager.

See Also:

setTo(ilog.tgo.model.IltObject)

Internal: do not use!

getNextFrom

public IltObject getNextFrom(IltGraphicManager manager)

Returns the object that will be used as the first extremity of the link, the next time the link is added to a manager. This object is the one set by calling setLogicalFrom; it is overridden by calling setNextFrom, and reset by the addition of the link to a manager.

Internal: do not use!

getNextTo

public IltObject getNextTo(IltGraphicManager manager)

Returns the object that will be used as the second extremity of the link, the next time the link is added to a manager. This object is the one set by calling setLogicalTo; it is overridden by calling setNextTo, and reset by the addition of the link to a manager.

Internal: do not use!

transformPosition

public Object transformPosition(IltGraphicManager manager,
                                Object position)

Applies the manager transformer to the position parameter. This is called by computeGraphic (mgr, position)

Specified by:

transformPosition in class IltObject

Internal: do not use!

isValidPosition

public boolean isValidPosition(Object position)

Description copied from class: IltObject

Determines whether the argument is a valid position/shape for this type of object.

This function overridden in subclasses. Accepted positions are:

• IlvPoint for IltNetworkElement, IltOffPageConnector, IltShelf,
• IlvRect for IltRectGroup, IltShelfItem,
• IlpPolyline for IltAbstractLink, IltLinearGroup,
• IlpPolygon for IltPolyGroup.

Specified by:

isValidPosition in class IltObject

Internal: do not use!

createPositionUpdate

public ilog.tgo.graphic.internal.IltGraphicUpdate createPositionUpdate(Object position,
                                                                       Object positionInManager)

Creates the graphic update responsible for setting the position/shape to a graphical representation. If the given position is null, the position/shape set will be the default value.

Specified by:

createPositionUpdate in class IltObject

Parameters:

position - the shape in stationary coordinates

positionInManager - the shape in manager coordinates (takes into account the logical zoom transformer)

Internal: do not use!

usingDefaultShape

public boolean usingDefaultShape(IltGraphicManager manager)

Computes the graphic representation of the object in the given manager. This method is used internally. If the graphical representation of the object is not yet created, then it creates the representation with the given shape. Otherwise, it verifies if the current shape is the default one, and only in this case it used the new shape. If the current shape is not the default, we assume it was set by the user, and let it as it is.

Overrides:

usingDefaultShape in class IltObject

Internal: do not use!

updateShapeGraphicSettingInManager

public void updateShapeGraphicSettingInManager(IltGraphicManager manager,
                                               IltGraphic graphic,
                                               Object newShape,
                                               IlpPositionSource reason)

If the graphic representation is visible, updates the shape graphic setting in manager coordinates.

Overrides:

updateShapeGraphicSettingInManager in class IltObject

newShape - the new shape in stationary coordinates; null means the current value of the shape graphic setting

reason - the reason for the shape change, or null if unknown

Internal: do not use!

forgetShapeGraphicSettingInManager

protected void forgetShapeGraphicSettingInManager(IltGraphicManager manager,
                                                  IltGraphic graphic)

Removes the shape graphic setting in manager coordinates.

Overrides:

forgetShapeGraphicSettingInManager in class IltObject

Internal: do not use!

getShape

@Deprecated
public IlpPolyline getShape(IltGraphicManager manager)

Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation visible. When working with datasource, please use getPosition instead.

Returns as an IlpPolyline the current shape of the link in the given manager. The result must be cloned to be modified.

Parameters:

manager - the manager in which the shape is queried

Note that this method is not supposed to be used when this IltAbstractLink is in a DataSource.

Deprecated Since:

JTGO 3.5

getShape

protected IlpPolyline getShape(IltGraphicManager manager,
                               IltGraphic graphic)

Returns the shape graphic setting.

Internal: do not use!

setShape

@Deprecated
public void setShape(IltGraphicManager manager,
                                 IlpPolyline shape)

Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation visible. When working with datasources, please use setPosition instead.

Changes the shape of the link in the given manager. The given shape is not cloned by this method. This method replaces IltCompositeGrapher.setLinkSkeleton.

Parameters:

manager - the manager where to set the shape

shape - the open polyline to use for the shape

Note that this method is not supposed to be used when this IltAbstractLink is in a DataSource.

Deprecated Since:

JTGO 3.5

setShape

@Deprecated
public void setShape(IltGraphicManager manager,
                                 IlpPolyline shape,
                                 IlpPositionSource reason)

Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation visible. When working with datasources, please use setPosition instead.

Changes the shape of the link in the given manager. The given shape is not cloned by this method. This method replaces IltCompositeGrapher.setLinkSkeleton.

Parameters:

manager - the manager where to set the shape

shape - the open polyline to use for the shape

reason - the reason for the shape change, or null if unknown

Note that this method is not supposed to be used when this IltAbstractLink is in a DataSource.

Deprecated Since:

JTGO 3.5

setShape

@Deprecated
public void setShape(IltGraphicManager manager,
                                 IltLogicalPolyline shape)

Deprecated. Please use IlpPolyline instead of IltLogicalPolyline.

Changes the shape of the link in the given manager. The given shape is not cloned by this method. This method replaces IltCompositeGrapher.setLinkSkeleton.

Parameters:

manager - the manager where to set the shape

shape - the open polyline to use for the shape

Deprecated Since:

JTGO 3.0

setShape

public void setShape(IltGraphicManager manager,
                     IltGraphic graphic,
                     IlpPolyline shape,
                     IlpPositionSource reason)

Changes the shape graphic setting.

Internal: do not use!

getShapeInManager

protected IlpPolyline getShapeInManager(IltGraphicManager manager,
                                        IltGraphic graphic)

Returns the position of the graphic representation in a given IltGraphicManager.

Internal: do not use!

getShapeInManager

public IlpPolyline getShapeInManager(IltGraphic graphic)

For convenience, since the above does not really depend on the manager.

Internal: do not use!

setShapeInManagerAux

protected void setShapeInManagerAux(IltGraphicManager manager,
                                    IltGraphic graphic,
                                    IlpPolyline shape,
                                    IlpPositionSource reason,
                                    boolean assumeVisible)

Changes the position of the graphic representation in a given IltGraphicManager. No optimizations here.

Internal: do not use!

setShapeInManager

public void setShapeInManager(IltGraphicManager manager,
                              IltGraphic graphic,
                              IlpPolyline shape,
                              IlpPositionSource reason,
                              boolean assumeVisible)

Changes the shape of the link in the given manager, using the provided composite graphic. The given shape is not cloned by this method, and has already been adjusted to take into account the manager's zoom transformer. This method is used by the layout optimizers, because they may handle composite graphics that are not yet associated with their links.

Parameters:

manager - the manager where to set the shape

graphic - the composite graphic representing the link in the manager

shape - the open polyline to use for the shape, in manager coordinates

reason - the reason for the shape change, or null if unknown

assumeVisible - true if the graphic object is known become visible soon

Internal: do not use!

getCenterPoint

protected IlvPoint getCenterPoint(IltGraphicManager manager,
                                  IltGraphic graphic)

Returns the position of the graphic representation in a given IltcObjectContainer.

Specified by:

getCenterPoint in class IltObject

Internal: do not use!

setCenterPoint

public void setCenterPoint(IltGraphicManager manager,
                           IltGraphic graphic,
                           IlvPoint position,
                           IlpPositionSource reason)

Changes the position of the graphic representation in a given IltcObjectContainer.

Specified by:

setCenterPoint in class IltObject

Internal: do not use!

getBaseRectangle

public IlvRect getBaseRectangle(IltGraphicManager manager)

Returns the base rectangle of the graphic representation in a given IltGraphicManager.

Specified by:

getBaseRectangle in class IltObject

Returns:

null if the base has no extent at all

Internal: do not use!

setBaseRectangle

public void setBaseRectangle(IltGraphicManager manager,
                             IlvRect newBaseRectangle)

Applies a transformation to the graphic representation in a given IltGraphicManager, attempting to make the base rectangle resemble the given rectangle.

Specified by:

setBaseRectangle in class IltObject

Internal: do not use!

setShapeGraphicSetting

public void setShapeGraphicSetting(IltGraphic graphic,
                                   Object newShape)

Sets the graphic settings responsible for the shape of the object.

Overrides:

setShapeGraphicSetting in class IltObject

Internal: do not use!

setShapeInManagerGraphicSetting

public void setShapeInManagerGraphicSetting(IltGraphic graphic,
                                            Object newShape,
                                            IlpPositionSource reason)

Sets the graphic settings responsible for the shape of the object in a given manager

Overrides:

setShapeInManagerGraphicSetting in class IltObject

Internal: do not use!

getWidth

@Deprecated
public double getWidth(IltGraphicManager manager)

Deprecated.

Returns the width of the link in the given manager.

Parameters:

manager - the manager in which the shape is queried

Note that this method is not supposed to be used when this IltAbstractLink is in a DataSource.

Deprecated Since:

JTGO 3.5

getWidth

public abstract double getWidth(IltGraphicManager manager,
                                IltGraphic graphic)

Returns the width of the graphic representation. This function assumes that the graphic representation exists and is visible (or about to become visible).

Internal: do not use!

initializeVisibleGraphic

public void initializeVisibleGraphic(IltGraphicManager manager,
                                     IltGraphic graphic)

This is called before adding a graphic representation to a given view. Here we initialize the extremities of the link, ensuring that both are in the manager; and we compute the initial layoutability of the link.

Overrides:

initializeVisibleGraphic in class IltObject

Internal: do not use!

postCreateGraphic

public void postCreateGraphic(IltGraphicManager manager,
                              IltGraphic graphic)

This is called at the end of adding a graphic representation to a given view. Here we add the link either as a link or as an object, depending on whether the manager is a grapher or not.

Overrides:

postCreateGraphic in class IltObject

Internal: do not use!

removeGraphic

public void removeGraphic(IltGraphicManager manager)

Removes the graphic representation of this link from the given manager. What is new here is that if the link is in a link set which is in the manager, we remove the link from the link set.

Overrides:

removeGraphic in class IltObject

restoreVisibility

@Deprecated
public void restoreVisibility(IltGraphicManager manager,
                                          IltGraphicSettings settings)

Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation visible. Once visible, it is updated automatically when needed.

This implementation does nothing if this link is contained. It calls super.restoreVisibility if it is not contained.

Overrides:

restoreVisibility in class IltObject

See Also:

IltObject.setGraphicSettings(ilog.tgo.graphic.IltGraphicManager, ilog.tgo.graphic.IltGraphicSettings)

Deprecated Since:

JTGO 3.5

applyTransform

@Deprecated
public void applyTransform(IltGraphicManager manager,
                                       IltGraphic graphic,
                                       IlvTransformer t,
                                       IlpPositionSource reason)

Deprecated.

Description copied from class: IltObject

Applies a transform to the location of the graphic representation in a given IltGraphicManager.

Note: t is given relative to the stationary coordinate system, which is the coordinate system used by the other IltObject subclasses API functions.

Note that this method is not supposed to be used when this IltObject is in a DataSource.

Specified by:

applyTransform in class IltObject

Parameters:

manager - The graphic manager where the object is displayed.

graphic - The graphic representation in the manager.

t - The transform parameter.

reason - The reason for the shape change, or null if unknown

See Also:

IltObject.applyTransform(ilog.tgo.graphic.IltGraphicManager, ilog.views.IlvTransformer), IltGraphicManager.getZoomTransformer()

Deprecated Since:

JTGO 3.5

setLinkLayoutProxyPresent

public void setLinkLayoutProxyPresent(IltGraphicManager manager,
                                      boolean layoutable)

Sets the layoutability of the link in the given manager.

Internal: do not use!

getRepresentation

public IltLineSpec getRepresentation()

Returns the graphic representation of the link, if fixed. If the return value is null, the graphic representation is determined by the semantic state.

Internal: do not use!

copyFrom

protected void copyFrom(IltAbstractLink other)

Support for renderer.

Internal: do not use!

updateFrom

public void updateFrom(IltObject other)

Updates the local cache of attributes stored in getObjectAttribute(). Overridden here to handle the IltLinkBundle case, which can be rendered by its overview object.

Overrides:

updateFrom in class IltObject

Internal: do not use!

toString

public String toString()

Returns the String representation of this IltAbstractLink's values.

Overrides:

toString in class IlpDefaultObject

Internal: do not use!

getOutermostParentGraphic

public IltGraphic getOutermostParentGraphic(IltGraphicManager manager)

This method is overridden by the subclasses which can be contained in other IltObjects. This is valid for shelf items which are inside shelves.

Internal: do not use!

ForceInit

public static void ForceInit(ilog.tgo.util.internal.IltForceClassInit object)

To deserialize IltClassLegend instances.

Internal: do not use!