ilog.tgo.model
Class IltPort

java.lang.Object
  ilog.cpl.model.IlpDefaultObject
      ilog.tgo.model.IltObject
          ilog.tgo.model.IltCardItem
              ilog.tgo.model.IltPort

All Implemented Interfaces:

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

public class IltPort
extends IltCardItem

This class models port elements, which are equipment connectors.

Ports are managed objects that can have their state managed through any ILOG JTGO state dictionary such as OSI or SNMP.

An IltPort is a subclass of IltCardItem; it is designed to fit inside an IltCard container. Ports differ from each other according to their type, which also defines their graphic representation. There are two kinds of port representations, based on image or on vector base renderers.

There are several predefined types of ports. It is possible to create your own port types and associate your specific base renderer to create its graphic representation.

Since:

JTGO 3.0

Nested Class Summary

static class

IltPort.Type This enumeration lists the types of ports.

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

IltObject.ListPrimaryStateStyleValueProvider, IltObject.LogicalType, IltObject.TinyType

Field Summary

static IltPort.Type	DefaultType The default type for a new port object.
static IltObjectInfo	metainfo Contains metainformation about this IltObject class.

Fields inherited from class ilog.tgo.model.IltCardItem

AntiAliasing, DirectionAttribute, TypeAttribute

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

IltPort(IlpClass ilpClass, Object identifier)
Creates a new port with the given class and identifier.

IltPort(Object identifier)
Creates a new port with the given identifier.

IltPort(String label, IltPort.Type type, IltObjectState state)
Creates a new port based on a given label, type and object state.

Method Summary

ilog.tgo.graphic.internal.base.IltBaseElement	createBase(IltcGraphicElementAggregate root) Creates a base element, suitable for this particular kind of object.
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.
static IltObjectInfo	GetIlpClass() Returns the IlpClass corresponding to this Java class.
IltPort.Type	getType() Gets the "type" of this object.
protected void	initializeObject(IltObjectState state, String name) This method is only called by the constructor.
void	setAttributeValue(IlpAttribute attribute, Object value) Sets the value of an attribute of this object.
void	setType(IltPort.Type type) Sets the "type" of this object.

Methods inherited from class ilog.tgo.model.IltCardItem

applyTransform, computeGraphic, copyFrom, createPositionUpdate, createTinyBase, getBaseRectangle, getCenterPoint, getContainer, GetDirectionMapping, getMappedForUserList, isItemMoveable, isValidPosition, setBaseRectangle, setCenterPoint, setContainer, SetDirectionMapping, setShapeInManagerGraphicSetting, transformPosition, updateShapeGraphicSettingInManager

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, defaultShape, endDelayingComputeGraphic, EndDelayingComputeGraphic, fireAllGraphicChanged, fireGraphicChanged, ForceInit, forgetShapeGraphicSettingInManager, FromGraphic, getAlarmState, getAttacherInfo, getAttacherInfoController, getAutomaticDecorationsDirection, getBaseRectangleInManager, GetBaseStyleMapping, getCenterPoint, getCenterPointInManager, 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, setProperty, SetPropertyTransient, setSelected, setSelectedInternal, setShapeGraphicSetting, 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, toString

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 method or field: do not use!

DefaultType

public static IltPort.Type DefaultType

The default type for a new port object. Default value: IltPort.Type.DB_15f

Constructor Detail

IltPort

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

Creates a new port based on a given label, type and object state.

Parameters:

label - The label of the port

type - The type of the port

state - The semantic state of the port

IltPort

public IltPort(Object identifier)

Creates a new port with the given identifier.

The attributes must be set using the appropriate accessors.

Parameters:

identifier - The identifier of this new instance

See Also:

IltObject.setLabel(java.lang.String), setType(ilog.tgo.model.IltPort.Type), IltObject.setObjectState(ilog.tgo.model.IltObjectState)

IltPort

public IltPort(IlpClass ilpClass,
               Object identifier)

Creates a new port with the given class and identifier.

The attributes must be set using the appropriate accessors.

Parameters:

ilpClass - The business class of this new instance. It must be a subclass of IltPort.

identifier - The identifier of this new instance

See Also:

IltObject.setLabel(java.lang.String), setType(ilog.tgo.model.IltPort.Type), IltObject.setObjectState(ilog.tgo.model.IltObjectState)

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.

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 method or field: do not use!

getType

public IltPort.Type getType()

Gets the "type" of this object.

Returns:

The object type

setType

public void setType(IltPort.Type type)

Sets the "type" of this object.

Parameters:

type - The new object type

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 IltCardItem

Parameters:

attribute - The attribute which value is being set.

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

Throws:

IllegalArgumentException - If the attribute cannot have its value modified.

Since:

JTGO 3.0

createBase

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

Creates a base element, suitable for this particular kind of object.

Specified by:

createBase in class IltObject

Parameters:

root - The decoration hierarchy root.

See Also:

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

Internal method or field: do not use!

GetClassLegend

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