ilog.tgo.model

Class IltNetworkElement

java.lang.Object

ilog.cpl.model.IlpDefaultObject

ilog.tgo.model.IltObject

ilog.tgo.model.IltNetworkElement

All Implemented Interfaces:

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

public class IltNetworkElement
extends IltObject

This class models network nodes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IltNetworkElement.Family This enumeration lists the families of a network element.
static class	IltNetworkElement.Function This enumeration lists the functions of a network element.
static class	IltNetworkElement.Type Here is a list of the types of network elements.

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 IlpEnumKey	AlarmLossOfConnectivityPosition
static IlpIntegerKey	BSCActiveBorderThickness Deprecated. Please use property bscActiveBorderWidth instead.
static IlpIntegerKey	BTSActiveBorderThickness Deprecated. Please use property btsActiveBorderWidth instead.
static IlpBooleanKey	DisplayAlarmCountWhenCollapsed Deprecated. Please use the property alarmCountVisible with attribute selectors. The following CSS extract illustrates how you should proceed: object."ilog.tgo.model.IltNetworkElement" { collapsed: true; alarmCountVisible: false; alarmCountAbbreviated: true; } object."ilog.tgo.model.IltNetworkElement"[newAlarmHighestSeverity] { collapsed: false; alarmCountVisible: true; alarmCountAbbreviated: false; }
static IlpBooleanKey	ExpandOnNewAlarms Deprecated. Please use property collapsed with the attribute selectors, as illustrated in the following example: object."ilog.tgo.model.IltNetworkElement" { collapsed: true; } object."ilog.tgo.model.IltNetworkElement"[newAlarmHighestSeverity] { collapsed: false; }
static IlpBooleanKey	FamilyAntialiasing Deprecated. Please use property familyAntialiasing instead.
static IltAttribute	FamilyAttribute Attribute used to define the family of the network element.
static IlpColorKey	FamilyBackgroundColor Deprecated. Please use property familyBackground instead.
static IlpFontKey	FamilyFont Deprecated. Please use property familyFont instead.
static IlpColorKey	FamilyForegroundColor Deprecated. Please use property familyForeground instead.
static IlpStringKey	FamilyLabel
static IlpBooleanKey	FamilyVisible Deprecated. Please use property familyVisible instead.
static IltAttribute	FunctionAttribute Attribute used to define the function of the network element.
static IlpImageKey	FunctionIcon
static IlpBooleanKey	FunctionVisible Deprecated. Please use property functionVisible instead.
static IlpBooleanKey	IsCollapsed Deprecated. Please use property collapsed instead.
static IlpColorKey	MDGreenButtonColor Deprecated. Please use property mdGreenButtonColor instead.
static IlpColorKey	MDRedButtonColor Deprecated. Please use property mdRedButtonColor instead.
static IlpColorKey	MDShadowColor Deprecated. Please use property mdShadowColor instead.
static IltObjectInfo	metainfo Contains metainformation about this IltObject class.
static IlpIntegerKey	MSCActiveBorderThickness Deprecated. Please use property mscActiveBorderWidth instead.
static IlpColorKey	NMWButtonColor Deprecated. Please use property nmwButtonColor instead.
static IlpColorKey	NMWScreenColor Deprecated. Please use property nmwScreenColor instead.
static IltAttribute	PartialAttribute An attribute that is used to define whether the network element is a partial network element or not.
static IlpImageKey	PartialIcon
static IlpBooleanKey	PartialIconVisible
static IlpColorKey	ServerButtonColor Deprecated. Please use property serverButtonColor instead.
static IlpColorKey	ServerGridColor Deprecated. Please use property serverGridColor instead.
static IltAttribute	ShortcutAttribute An attribute that is used to define whether the network element is a shortcut network element or not.
static IlpKey	SizeRatio Deprecated. Please use property sizeRatio instead.
static IltAttribute	TypeAttribute Attribute used to define the type of the network element.

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
IltNetworkElement(IlpClass ilpClass, Object identifier) Creates a new network element with a given identifier and a given IlpClass.
IltNetworkElement(Object identifier) Creates a new network element with a given identifier.
IltNetworkElement(String label, IltNetworkElement.Type type, IltNetworkElement.Function function, IltNetworkElement.Family family, IltObjectState state) Creates a new node.
IltNetworkElement(String label, IltNetworkElement.Type type, IltObjectState state) Creates a new node.

Method Summary

Modifier and Type	Method and Description
void	applyTransform(IltGraphicManager manager, IltGraphic graphic, IlvTransformer t, IlpPositionSource reason) Deprecated.
void	computeGraphic(IltGraphicManager manager, IlvPoint position) Deprecated. To make this object visible at a given position, please use the method setPosition and add this object to a datasource.
ilog.tgo.graphic.internal.base.IltBaseElement	createBase(IltcGraphicElementAggregate root) Creates a base element, suitable for this particular kind of object, for use with the Symbolic Graphic Representation Style (GRS).
ilog.tgo.graphic.internal.IltGraphicUpdate	createPositionUpdate(Object position, Object positionInManager) Creates the graphic update responsible for setting the position/shape to a graphical representation.
ilog.tgo.graphic.internal.base.IltBaseElement	createTinyBase(IltcGraphicElementAggregate root) Creates a base element, suitable for this particular kind of object, for us with the Tiny Graphic Representation Style (GRS).
Object	defaultShape() Returns the default shape, used when an object is made visible without having been assigned a shape.
static void	ForceInit(ilog.tgo.util.internal.IltForceClassInit object)
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 shape graphic setting.
IlvPoint	getCenterPointInManager(IltGraphicManager manager, IltGraphic graphic) Returns the position of the graphic representation in a given IltGraphicManager.
static IltLegend	GetClassLegend() Deprecated. The style API has been replaced by the cascading style sheet mechanism. Refer to the User's Manual for further information.
IltNetworkElement.Family	getFamily() Returns the family of this object.
IltNetworkElement.Function	getFunction() Returns the function of this object.
static IltObjectInfo	GetIlpClass() Returns the IlpClass corresponding to this Java class.
ilog.util.internal.IlAVector	getMappedForUserList()
IltShortcutAttributeType	getShortcut() Returns if the network element is a shortcut or not.
IlvTransformer	getSizeRatio(IltGraphicManager manager) Deprecated. Please use CSS property sizeRatio instead.
IltNetworkElement.Type	getType() Returns the type of this object.
protected void	initializeObject(IltObjectState state, String name) This method is only called by the constructor.
boolean	isCollapsed(IltGraphicManager manager) Deprecated. Please use CSS property collapsed instead.
boolean	isPartial() Returns if the network element is a partial element or not.
boolean	isValidPosition(Object position) Determines whether the argument is a valid position/shape for this type of object.
void	setAttributeValue(IlpAttribute attribute, Object value) Sets the value of an attribute of this object.
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 shape graphic setting.
void	setCollapsed(IltGraphicManager manager, boolean collapsed) Deprecated. Use CSS property collapsed instead.
void	setFamily(IltNetworkElement.Family family) Sets the family of this object.
void	setFunction(IltNetworkElement.Function function) Sets the function of this object.
void	setPartial(boolean value) Sets the network element as a partial element.
void	setProperty(Object name, Object value) Sets the named property.
void	setShortcut(IltShortcutAttributeType value) Sets the network element as a shortcut.
void	setSizeRatio(IltGraphicManager manager, IlvTransformer mag) Deprecated. Please use CSS property sizeRatio instead.
void	setType(IltNetworkElement.Type type) Sets the type of this object.
String	toString() Returns the String representation of this IltNetworkElement's values.
Object	transformPosition(IltGraphicManager manager, Object position) Applies the manager transformer to the position parameter.
void	updateShapeGraphicSettingInManager(IltGraphicManager manager, IltGraphic graphic, Object newShape, IlpPositionSource reason) If the graphic representation is visible, updates the shape graphic setting in manager coordinates.

Methods inherited from class ilog.tgo.model.IltObject

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

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!

TypeAttribute

public static IltAttribute TypeAttribute

Attribute used to define the type of the network element. The type determines how the base of the network element will be represented.

Attribute name: type.

Value type: IltNetworkElement.Type.

Since:

JTGO 3.0

See Also:

getType(), setType(ilog.tgo.model.IltNetworkElement.Type)

FunctionAttribute

public static IltAttribute FunctionAttribute

Attribute used to define the function of the network element. The function is graphically represented by an icon that is placed at the bottom left or in the center of the network element base.

Attribute name: function.

Value type: IltNetworkElement.Function.

Since:

JTGO 3.0

See Also:

getFunction(), setFunction(ilog.tgo.model.IltNetworkElement.Function)

FamilyAttribute

public static IltAttribute FamilyAttribute

Attribute used to define the family of the network element. The family is graphically represented by a label that is placed at the bottom right of the network element base. It is designed to be used mostly with network elements of type IltNetworkElement.Type.NE.

Attribute name: family.

Value type: IltNetworkElement.Family.

Since:

JTGO 3.0

See Also:

getFunction(), setFunction(ilog.tgo.model.IltNetworkElement.Function)

PartialAttribute

public static IltAttribute PartialAttribute

An attribute that is used to define whether the network element is a partial network element or not.

A partial network element is an abstraction that represents that this network element is only part of the network element currently present in the back-end. Partial network elements can be used in several situations:

• To represent distributed clusters where the parts of a cluster need to be divided out across different subnetworks.
• To represent that one network element in the back-end system may be used by different service providers. In this case, the network element needs to be divided in two parts. Each part is represented as a partial network element. Its state reflects only the elements that are interesting for the service provider that is using it.

Partial network elements are graphically represented by an icon that is placed at the bottom left side of the network element base.

Attribute name: partial.

Value type: Boolean.

Since:

JTGO 4.0

See Also:

isPartial(), setPartial(boolean)

ShortcutAttribute

public static IltAttribute ShortcutAttribute

An attribute that is used to define whether the network element is a shortcut network element or not.

A shortcut network element is an abstraction that represents that this network element is only a reference to an existing network element. The possible values for this attribute are:

• IltShortcutAttributeType.STANDARD: this network element is a normal shortcut.
• IltShortcutAttributeType.DANGLING: this network element is a shortcut to an object that is no longer available.
• null: the network element is not a shortcut.

Shortcut network elements are graphically represented by an icon that is placed at the bottom left side of the network element base.

Attribute name: shortcut.

Value type: IltShortcutAttributeType.

Since:

JTGO 4.0

See Also:

getShortcut(), setShortcut(ilog.tgo.model.attribute.IltShortcutAttributeType)

ExpandOnNewAlarms

@Deprecated
public static IlpBooleanKey ExpandOnNewAlarms

Deprecated. Please use property collapsed with the attribute selectors, as illustrated in the following example:

 object."ilog.tgo.model.IltNetworkElement" {
   collapsed: true;
 }
 object."ilog.tgo.model.IltNetworkElement"[newAlarmHighestSeverity] {
   collapsed: false;
 }
 

The legend property denoting whether the network element can be collapsed when a new alarm is present.

See Also:

IltObjectCustomization.getExpandOnNewAlarms()

Deprecated Since:

JTGO 3.5

FamilyForegroundColor

@Deprecated
public static IlpColorKey FamilyForegroundColor

Deprecated. Please use property familyForeground instead.

The legend property denoting the foreground color of the family.

See Also:

IltObjectCustomization.getFamilyForeground()

Deprecated Since:

JTGO 3.5

FamilyBackgroundColor

@Deprecated
public static IlpColorKey FamilyBackgroundColor

Deprecated. Please use property familyBackground instead.

The legend property denoting the background color of the family. If the value is null, no background rectangle will be drawn.

See Also:

IltObjectCustomization.getFamilyBackground()

Deprecated Since:

JTGO 3.5

FamilyFont

@Deprecated
public static IlpFontKey FamilyFont

Deprecated. Please use property familyFont instead.

The legend property denoting the font used to draw the family text.

See Also:

IltObjectCustomization.getFamilyFont()

Deprecated Since:

JTGO 3.5

FamilyAntialiasing

@Deprecated
public static IlpBooleanKey FamilyAntialiasing

Deprecated. Please use property familyAntialiasing instead.

The legend property denoting whether the family text is drawn with anti-aliasing.

See Also:

IltObjectCustomization.isFamilyAntialiasing()

Deprecated Since:

JTGO 3.5

FamilyVisible

@Deprecated
public static IlpBooleanKey FamilyVisible

Deprecated. Please use property familyVisible instead.

The legend property denoting whether the family text is visible.

See Also:

IltObjectCustomization.isFamilyVisible()

Deprecated Since:

JTGO 3.5

FunctionVisible

@Deprecated
public static IlpBooleanKey FunctionVisible

Deprecated. Please use property functionVisible instead.

The legend property denoting whether the function icon is visible.

See Also:

IltObjectCustomization.isFunctionVisible()

Deprecated Since:

JTGO 3.5

DisplayAlarmCountWhenCollapsed

@Deprecated
public static IlpBooleanKey DisplayAlarmCountWhenCollapsed

Deprecated. Please use the property alarmCountVisible with attribute selectors. The following CSS extract illustrates how you should proceed:

 object."ilog.tgo.model.IltNetworkElement" {
   collapsed: true;
   alarmCountVisible: false;
   alarmCountAbbreviated: true;
 }
 object."ilog.tgo.model.IltNetworkElement"[newAlarmHighestSeverity] {
   collapsed: false;
   alarmCountVisible: true;
   alarmCountAbbreviated: false;
 }
 

The legend property denoting whether the base displays the alarm count instead of the function when it is collapsed.

See Also:

IltObjectCustomization.getDisplayAlarmCountWhenCollapsed()

Deprecated Since:

JTGO 3.5

SizeRatio

@Deprecated
public static IlpKey SizeRatio

Deprecated. Please use property sizeRatio instead.

The legend property denoting the magnification (= size ratio) of the node. Its value is a scale IlvTransformer.

Since:

JTGO 3.1

See Also:

IltObjectCustomization.getSizeRatio()

Deprecated Since:

JTGO 3.5

IsCollapsed

@Deprecated
public static IlpBooleanKey IsCollapsed

Deprecated. Please use property collapsed instead.

The legend property denoting whether the network element is collapsed or not.

See Also:

IltObjectCustomization.isCollapsed()

Deprecated Since:

JTGO 3.5

PartialIcon

public static IlpImageKey PartialIcon

Internal: do not use!

PartialIconVisible

public static IlpBooleanKey PartialIconVisible

Internal: do not use!

FunctionIcon

public static IlpImageKey FunctionIcon

Internal: do not use!

FamilyLabel

public static IlpStringKey FamilyLabel

Internal: do not use!

AlarmLossOfConnectivityPosition

public static IlpEnumKey AlarmLossOfConnectivityPosition

Internal: do not use!

MDShadowColor

@Deprecated
public static IlpColorKey MDShadowColor

Deprecated. Please use property mdShadowColor instead.

For type MD, the legend property denoting the color of the dark border.

See Also:

IltrColor.MDBorderDark, IltObjectCustomization.getMdShadowColor()

Deprecated Since:

JTGO 3.5

MDRedButtonColor

@Deprecated
public static IlpColorKey MDRedButtonColor

Deprecated. Please use property mdRedButtonColor instead.

For type MD, the legend property denoting the color of the red button.

See Also:

IltObjectCustomization.getMdRedButtonColor(), IltrColor.MDButtonRed

Deprecated Since:

JTGO 3.5

MDGreenButtonColor

@Deprecated
public static IlpColorKey MDGreenButtonColor

Deprecated. Please use property mdGreenButtonColor instead.

For type MD, the legend property denoting the color of the green button.

See Also:

IltObjectCustomization.getMdGreenButtonColor(), IltrColor.MDButtonGreen

Deprecated Since:

JTGO 3.5

ServerGridColor

@Deprecated
public static IlpColorKey ServerGridColor

Deprecated. Please use property serverGridColor instead.

For type Server, the legend property denoting the color of the grid.

See Also:

IltObjectCustomization.getServerGridColor()

Deprecated Since:

JTGO 3.5

ServerButtonColor

@Deprecated
public static IlpColorKey ServerButtonColor

Deprecated. Please use property serverButtonColor instead.

For type Server, the legend property denoting the color of the button.

See Also:

IltObjectCustomization.getServerButtonColor()

Deprecated Since:

JTGO 3.5

NMWScreenColor

@Deprecated
public static IlpColorKey NMWScreenColor

Deprecated. Please use property nmwScreenColor instead.

For type NMW, the legend property denoting the color of the screen, unless overridden by the object state.

See Also:

IltObjectCustomization.getNmwScreenColor(), IltrColor.NMWScreen

Deprecated Since:

JTGO 3.5

NMWButtonColor

@Deprecated
public static IlpColorKey NMWButtonColor

Deprecated. Please use property nmwButtonColor instead.

For type NMW, the legend property denoting the color of the button.

See Also:

IltObjectCustomization.getNmwButtonColor(), IltrColor.NMWButton

Deprecated Since:

JTGO 3.5

BSCActiveBorderThickness

@Deprecated
public static IlpIntegerKey BSCActiveBorderThickness

Deprecated. Please use property bscActiveBorderWidth instead.

For type BSC, the legend property denoting the thickness of the border when the style is CarryingTraffic.

See Also:

IltObjectCustomization.getBscActiveBorderWidth()

Deprecated Since:

JTGO 3.5

MSCActiveBorderThickness

@Deprecated
public static IlpIntegerKey MSCActiveBorderThickness

Deprecated. Please use property mscActiveBorderWidth instead.

For type MSC, the legend property denoting the thickness of the border when the style is CarryingTraffic.

See Also:

IltObjectCustomization.getMscActiveBorderWidth()

Deprecated Since:

JTGO 3.5

BTSActiveBorderThickness

@Deprecated
public static IlpIntegerKey BTSActiveBorderThickness

Deprecated. Please use property btsActiveBorderWidth instead.

For type BTS, the legend property denoting the thickness of the border when the style is CarryingTraffic.

See Also:

IltObjectCustomization.getBtsActiveBorderWidth()

Deprecated Since:

JTGO 3.5

Constructor Detail

IltNetworkElement

public IltNetworkElement(Object identifier)

Creates a new network element with a given identifier.

Parameters:

identifier - The identifier of the new network element instance

Since:

JTGO 3.0

IltNetworkElement

public IltNetworkElement(IlpClass ilpClass,
                         Object identifier)

Creates a new network element with a given identifier and a given IlpClass.

Parameters:

ilpClass - The business class of the new network element instance. It must be a subclass of IltNetworkElement.

identifier - The identifier of this new instance

Since:

JTGO 3.0

IltNetworkElement

public IltNetworkElement(String label,
                         IltNetworkElement.Type type,
                         IltObjectState state)

Creates a new node. An ID is automatically generated using IlpIDGenerator.GetID().

Parameters:

label - The label of the node.

type - The type of the node.

state - The semantic state of the node.

IltNetworkElement

public IltNetworkElement(String label,
                         IltNetworkElement.Type type,
                         IltNetworkElement.Function function,
                         IltNetworkElement.Family family,
                         IltObjectState state)

Creates a new node. An ID is automatically generated using IlpIDGenerator.GetID().

Parameters:

label - The label of the node.

type - The type of the node.

function - The function of the node (may be null).

family - The family of the node (may be null).

state - The semantic state of the node.

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. 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

getType

public IltNetworkElement.Type getType()

Returns the type of this object.

setType

public void setType(IltNetworkElement.Type type)

Sets the type of this object.

getFunction

public IltNetworkElement.Function getFunction()

Returns the function of this object.

setFunction

public void setFunction(IltNetworkElement.Function function)

Sets the function of this object.

getFamily

public IltNetworkElement.Family getFamily()

Returns the family of this object.

setFamily

public void setFamily(IltNetworkElement.Family family)

Sets the family of this object.

isPartial

public boolean isPartial()

Returns if the network element is a partial element or not.

Since:

JTGO 4.0

setPartial

public void setPartial(boolean value)

Sets the network element as a partial element.

Since:

JTGO 4.0

getShortcut

public IltShortcutAttributeType getShortcut()

Returns if the network element is a shortcut or not.

Since:

JTGO 4.0

setShortcut

public void setShortcut(IltShortcutAttributeType value)

Sets the network element as a shortcut.

Since:

JTGO 4.0

initializeObject

protected void initializeObject(IltObjectState state,
                                String name)

This method is only called by the constructor.

Overrides:

initializeObject in class IltObject

See Also:

IltObject.initializeObject(ilog.tgo.model.IltObjectState, java.lang.String)

Internal: do not use!

setAttributeValue

public void setAttributeValue(IlpAttribute attribute,
                              Object value)

Sets the value of an attribute of this object. To remove the value of an attribute, you can pass VALUE_NOT_SET for the value argument.

Specified by:

setAttributeValue in interface IlpAttributeValueHolder

Overrides:

setAttributeValue in class IltObject

Parameters:

attribute - The attribute of which the value is set.

value - The new value of the attribute or VALUE_NOT_SET to remove the value of the attribute.

Throws:

IllegalArgumentException - if the attribute can not have its value modified.

Since:

JTGO 3.0

computeGraphic

@Deprecated
public void computeGraphic(IltGraphicManager manager,
                                       IlvPoint position)

Deprecated. To make this object visible at a given position, please use the method setPosition and add this object to a datasource.

Ensures that this object has a valid graphic representation in a given IltGraphicManager. The graphic representation is drawn at the given position.

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

Deprecated Since:

JTGO 3.5

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!

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!

getCenterPoint

protected IlvPoint getCenterPoint(IltGraphicManager manager,
                                  IltGraphic graphic)

Returns the shape graphic setting.

Specified by:

getCenterPoint in class IltObject

Internal: do not use!

setCenterPoint

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

Changes the shape graphic setting.

Specified by:

setCenterPoint in class IltObject

Internal: do not use!

getCenterPointInManager

public IlvPoint getCenterPointInManager(IltGraphicManager manager,
                                        IltGraphic graphic)

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

Overrides:

getCenterPointInManager 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!

defaultShape

public Object defaultShape()

Returns the default shape, used when an object is made visible without having been assigned a shape.

Overrides:

defaultShape in class IltObject

Internal: do not use!

getSizeRatio

@Deprecated
public IlvTransformer getSizeRatio(IltGraphicManager manager)

Deprecated. Please use CSS property sizeRatio instead.

Returns the magnification level of the graphic representation in a given IltGraphicManager. This is a scale transformer, and is normally null.

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

See Also:

SizeRatio

Deprecated Since:

JTGO 3.5

setSizeRatio

@Deprecated
public void setSizeRatio(IltGraphicManager manager,
                                     IlvTransformer mag)

Deprecated. Please use CSS property sizeRatio instead.

Changes the magnification level of the graphic representation in a given IltGraphicManager. The mag argument is a scale transform. If it is null, the default size is used, which is determined by the type.

Note: The graphic representation in manager must already exist, otherwise an exception is thrown. To force the existence of a graphic representation, use createGraphic(manager).

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

Deprecated Since:

JTGO 3.5

isCollapsed

@Deprecated
public boolean isCollapsed(IltGraphicManager manager)

Deprecated. Please use CSS property collapsed instead.

Returns the collapsed state of the graphic representation in a given IltGraphicManager.

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

Deprecated Since:

JTGO 3.5

setCollapsed

@Deprecated
public void setCollapsed(IltGraphicManager manager,
                                     boolean collapsed)

Deprecated. Use CSS property collapsed instead.

Changes the collapsed state of the graphic representation in a given IltGraphicManager.

Note: The graphic representation in manager must already exist, otherwise an exception is thrown. To force the existence of a graphic representation, use createGraphic(manager).

Parameters:

manager - The graphic manager where this object is being displayed.

collapsed - If true, the size will be 53.5% of the normal size.

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

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

toString

public String toString()

Returns the String representation of this IltNetworkElement's values.

Overrides:

toString in class IlpDefaultObject

Internal: do not use!

setProperty

public void setProperty(Object name,
                        Object value)

Sets the named property. This method was overwritten here just to avoid the set of the properties which were replaced by the legend keys: Label direction and offset.

Specified by:

setProperty in interface IlWithProperties

Overrides:

setProperty in class IltObject

Parameters:

name - Property identifier

value - Property value

Internal: do not use!

createBase

public ilog.tgo.graphic.internal.base.IltBaseElement createBase(IltcGraphicElementAggregate root)

Creates a base element, suitable for this particular kind of object, for use with the Symbolic Graphic Representation Style (GRS).

Specified by:

createBase in class IltObject

See Also:

IltCompositeGraphic.createBase(IltcGraphicElementAggregate, IltObject), IltGraphicRepresentationStyle, IltBaseElement, createTinyBase(IltcGraphicElementAggregate)

Internal: do not use!

createTinyBase

public ilog.tgo.graphic.internal.base.IltBaseElement createTinyBase(IltcGraphicElementAggregate root)

Creates a base element, suitable for this particular kind of object, for us with the Tiny Graphic Representation Style (GRS).

Overrides:

createTinyBase in class IltObject

See Also:

IltCompositeGraphic.createBase(IltcGraphicElementAggregate, IltObject), IltGraphicRepresentationStyle, IltTinyElementBase, createBase(IltcGraphicElementAggregate)

Internal: do not use!

getMappedForUserList

public ilog.util.internal.IlAVector getMappedForUserList()

Overrides:

getMappedForUserList in class IltObject

Internal: do not use!

ForceInit

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

Internal: do not use!