|
||||||||||
| PREV CLASS Documentation homepage NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectilog.cpl.model.IlpDefaultObject
ilog.tgo.model.IltObject
ilog.tgo.model.IltNetworkElement
public class IltNetworkElement
This class models network nodes.
| Nested Class Summary | |
|---|---|
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 | |
|---|---|
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 interface ilog.cpl.model.IlpAttributeValueHolder |
|---|
VALUE_NOT_SET |
| Constructor Summary | |
|---|---|
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 | |
|---|---|
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 java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static IltObjectInfo metainfo
IltObject class.
public static IltAttribute TypeAttribute
Attribute name: type.
Value type: IltNetworkElement.Type.
getType(),
setType(ilog.tgo.model.IltNetworkElement.Type)public static IltAttribute FunctionAttribute
Attribute name: function.
Value type: IltNetworkElement.Function.
getFunction(),
setFunction(ilog.tgo.model.IltNetworkElement.Function)public static IltAttribute FamilyAttribute
IltNetworkElement.Type.NE.
Attribute name: family.
Value type: IltNetworkElement.Family.
getFunction(),
setFunction(ilog.tgo.model.IltNetworkElement.Function)public static IltAttribute PartialAttribute
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:
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.
isPartial(),
setPartial(boolean)public static IltAttribute ShortcutAttribute
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.
getShortcut(),
setShortcut(ilog.tgo.model.attribute.IltShortcutAttributeType)public static IlpBooleanKey ExpandOnNewAlarms
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;
}
IltObjectCustomization.getExpandOnNewAlarms()public static IlpColorKey FamilyForegroundColor
familyForeground instead.
IltObjectCustomization.getFamilyForeground()public static IlpColorKey FamilyBackgroundColor
familyBackground instead.null, no background rectangle will be drawn.
IltObjectCustomization.getFamilyBackground()public static IlpFontKey FamilyFont
familyFont instead.
IltObjectCustomization.getFamilyFont()public static IlpBooleanKey FamilyAntialiasing
familyAntialiasing instead.
IltObjectCustomization.isFamilyAntialiasing()public static IlpBooleanKey FamilyVisible
familyVisible instead.
IltObjectCustomization.isFamilyVisible()public static IlpBooleanKey FunctionVisible
functionVisible instead.
IltObjectCustomization.isFunctionVisible()public static IlpBooleanKey DisplayAlarmCountWhenCollapsed
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;
}
IltObjectCustomization.getDisplayAlarmCountWhenCollapsed()public static IlpKey SizeRatio
sizeRatio instead.IlvTransformer.
IltObjectCustomization.getSizeRatio()public static IlpBooleanKey IsCollapsed
collapsed instead.
IltObjectCustomization.isCollapsed()public static IlpImageKey PartialIcon
public static IlpBooleanKey PartialIconVisible
public static IlpImageKey FunctionIcon
public static IlpStringKey FamilyLabel
public static IlpEnumKey AlarmLossOfConnectivityPosition
public static IlpColorKey MDShadowColor
mdShadowColor instead.
IltrColor.MDBorderDark,
IltObjectCustomization.getMdShadowColor()public static IlpColorKey MDRedButtonColor
mdRedButtonColor instead.
IltObjectCustomization.getMdRedButtonColor(),
IltrColor.MDButtonRedpublic static IlpColorKey MDGreenButtonColor
mdGreenButtonColor instead.
IltObjectCustomization.getMdGreenButtonColor(),
IltrColor.MDButtonGreenpublic static IlpColorKey ServerGridColor
serverGridColor instead.
IltObjectCustomization.getServerGridColor()public static IlpColorKey ServerButtonColor
serverButtonColor instead.
IltObjectCustomization.getServerButtonColor()public static IlpColorKey NMWScreenColor
nmwScreenColor instead.
IltObjectCustomization.getNmwScreenColor(),
IltrColor.NMWScreenpublic static IlpColorKey NMWButtonColor
nmwButtonColor instead.
IltObjectCustomization.getNmwButtonColor(),
IltrColor.NMWButtonpublic static IlpIntegerKey BSCActiveBorderThickness
bscActiveBorderWidth instead.CarryingTraffic.
IltObjectCustomization.getBscActiveBorderWidth()public static IlpIntegerKey MSCActiveBorderThickness
mscActiveBorderWidth instead.CarryingTraffic.
IltObjectCustomization.getMscActiveBorderWidth()public static IlpIntegerKey BTSActiveBorderThickness
btsActiveBorderWidth instead.CarryingTraffic.
IltObjectCustomization.getBtsActiveBorderWidth()| Constructor Detail |
|---|
public IltNetworkElement(Object identifier)
identifier - The identifier of the new network element instance
public IltNetworkElement(IlpClass ilpClass,
Object identifier)
IlpClass.
ilpClass - The business class of the new network element instance. It must be a
subclass of IltNetworkElement.identifier - The identifier of this new instance
public IltNetworkElement(String label,
IltNetworkElement.Type type,
IltObjectState state)
IlpIDGenerator.GetID().
label - The label of the node.type - The type of the node.state - The semantic state of the node.
public IltNetworkElement(String label,
IltNetworkElement.Type type,
IltNetworkElement.Function function,
IltNetworkElement.Family family,
IltObjectState state)
IlpIDGenerator.GetID().
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 |
|---|
public static IltObjectInfo GetIlpClass()
IlpClass corresponding to this Java class.
Here the IlpClass interface is implemented by
IltObjectInfo.
public static IltLegend GetClassLegend()
public IltNetworkElement.Type getType()
public void setType(IltNetworkElement.Type type)
public IltNetworkElement.Function getFunction()
public void setFunction(IltNetworkElement.Function function)
public IltNetworkElement.Family getFamily()
public void setFamily(IltNetworkElement.Family family)
public boolean isPartial()
public void setPartial(boolean value)
public IltShortcutAttributeType getShortcut()
public void setShortcut(IltShortcutAttributeType value)
protected void initializeObject(IltObjectState state,
String name)