ilog.tgo.model
Class IltBTS

java.lang.Object
  extended by ilog.cpl.model.IlpDefaultObject
      extended by ilog.tgo.model.IltObject
          extended by ilog.tgo.model.IltBTS
All Implemented Interfaces:
IlpAttributeValueHolder, IlpObject, IltContainer, IltStateHolder, ilog.tgo.model.state.event.IltObjectStateListener, IltWithProperties, IlWithProperties, EventListener

public class IltBTS
extends IltObject
implements IltContainer

IltBTS is the class to represent Base Transceiver Station.

A BTS is made up of BTSAntenna objects, which represent cellular transmitting and receiving antennas. BTS objects play the role of graphic containers for IltBTSAntenna. The container includes also an IltObject object for representing the BTS electronic equipment.

The position attribute defines the center of the BTS container.

The BTS electronic equipment will be displayed at this point whereas the antenna objects will use it as their origins.

Since:
JTGO 3.0

Nested Class Summary
static class IltBTS.Type
          This enumeration lists the types of BTS.
 
Nested classes/interfaces inherited from class ilog.tgo.model.IltObject
IltObject.ListPrimaryStateStyleValueProvider, IltObject.LogicalType, IltObject.TinyType
 
Field Summary
static IlpFloatKey AlphaBeamWidth
          Deprecated. Please use CSS property alphaBeamWidth instead.
static IlpBooleanKey AntennaAntialiasing
          Deprecated. Please use CSS property antennaAntialiasing instead.
static IlpIntegerKey AntennaRadius
          Deprecated. Please use CSS property antennaRadius instead.
static IlpBooleanKey AntennaVisible
          Deprecated. Please use CSS property antennaVisible instead.
static IlpBooleanKey BeamWidthBorderVisible
          Deprecated. Please use CSS property beamWidthBorderVisible instead.
static IlpIntegerKey BeamWidthRadius
          Deprecated. Please use CSS property beamWidthRadius instead.
static IlpBooleanKey BeamWidthVisible
          Deprecated. Please use CSS property beamWidthVisible instead.
static IlpIntegerKey BTSEquipmentRadius
          Deprecated. Please use CSS property btsEquipmentRadius instead.
static IltObjectInfo metainfo
          Contains metainformation about this IltObject class.
static IlpIntegerKey PowerMaxValue
          Deprecated. Please use CSS property powerMaxValue instead.
static IlpIntegerKey Rotation
          Deprecated. Please use CSS property rotation instead.
static IltAttribute TypeAttribute
          Attribute used to define the type of the BTS.
 
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
IltBTS()
          Creates a new instance with a generated identifier.
IltBTS(IlpClass ilpClass, Object identifier)
          Creates a new instance with a given class and identifier.
IltBTS(Object identifier)
          Creates a new instance with a given identifier.
IltBTS(String label, IltBTSAntenna[] antennas)
          Deprecated. Containment relationships should be stored in a Datasource. Please use the DataSource API to declare the structure of your objects and use the BTS constructor that takes an identifier as argument.
IltBTS(String label, IltBTSAntenna[] antennas, IltNetworkElement equipment)
          Deprecated. Containment relationships should be stored in a Datasource. Please use the DataSource API to declare the structure of your objects and use the BTS constructor that takes an identifier as argument.
 
Method Summary
 void applyTransform(IltGraphicManager manager, IltGraphic graphic, IlvTransformer t, IlpPositionSource reason)
          Deprecated.  
 ilog.tgo.graphic.internal.base.IltBaseElement createBase(IltcGraphicElementAggregate root)
          Creates a base element, suitable for this particular kind of object.
 void createGraphic(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.
 ilog.tgo.graphic.internal.IltGraphicUpdate createPositionUpdate(Object position, Object positionInManager)
          Creates the graphic update responsible for setting the position/shape to a graphical representation.
 Object defaultShape()
          Returns the default shape, used when an object is made visible without having been assigned a shape.
 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.
 Enumeration getChildren()
          Returns the list of children objects, contained in this 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.
 IltChildrenModel getDetailObjects()
          Deprecated. Containment relationships should be stored in a Datasource. Please use the DataSource API to declare the structure of your objects.
static IltObjectInfo GetIlpClass()
          Returns the IlpClass corresponding to this Java class.
 ilog.util.internal.IlAVector getMappedForUserList()
           
 IltStateHolder getOverviewObject()
          Deprecated. BTS objects do not have an overview object.
 IltStatePropagator getStatePropagator()
          Deprecated. State propagation at the graphic level is not supported in the Network Component.
protected  void initializeBTS(IltBTSAntenna[] antennas)
          This method should only be called by the constructors.
 void initializeCreatedGraphic(IltGraphicManager manager, IltGraphic graphic)
          This method must be called just after preCreateGraphic to initialize any needed property or graphic setting.
protected  void initializeObject(IltObjectState state, String name)
          This method is only called by the constructor.
 boolean isValidPosition(Object position)
          Determines whether the argument is a valid position/shape for this type of object.
 void removeGraphic(IltGraphicManager manager)
          Removes the graphic representation of this object from a given IltGraphicManager.
 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 setDetailObjects(IltChildrenModel details)
          Deprecated. Containment relationships should be stored in a Datasource. Please use the DataSource API to declare the structure of your objects.
 void setOverviewObject(IltStateHolder overview)
          Deprecated. BTS objects do not have an overview object.
 void setStatePropagator(IltStatePropagator propagator)
          Deprecated. State propagation at the graphic level is not supported in the Network Component.
 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, createTinyBase, debug, endDelayingComputeGraphic, EndDelayingComputeGraphic, fireAllGraphicChanged, fireGraphicChanged, ForceInit, forgetShapeGraphicSettingInManager, FromGraphic, getAlarmState, getAttacherInfo, getAttacherInfoController, getAutomaticDecorationsDirection, getBaseRectangleInManager, GetBaseStyleMapping, getCenterPoint, 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, initializeDefaultValues, initializeVisibleGraphic, InitStyle, isEditable, isNearlyVisible, IsPropertyTransient, isSelected, isSelected, isVisible, mapDirection, mappedForUser, objectStateChanged, objectStateCleared, objectStateSet, postCreateGraphic, preCreateGraphic, removeGraphic, removeGraphic, removeGraphicChangedListener, removeGraphicSetting, removeGraphicSetting, removeProperty, removeStateChangedListener, resetLabelOffset, resetLabelOffset, resetLabelPosition, resetLabelPosition, resetState, restoreVisibility, 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, 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, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ilog.tgo.model.IltContainer
setObjectState
 
Methods inherited from interface ilog.tgo.model.IltStateHolder
addStateChangedListener, getObjectState, removeStateChangedListener
 

Field Detail

metainfo

public static IltObjectInfo metainfo
Contains metainformation about this IltObject class.

Internal method or field: do not use!

TypeAttribute

public static IltAttribute TypeAttribute
Attribute used to define the type of the BTS. Currently, there is only one type of BTS which is IltBTS.Type.Standard. Attribute name: type. Value type: ilog.tgo.model.IltBTS.Type.

Internal method or field: do not use!

Rotation

public static IlpIntegerKey Rotation
Deprecated. Please use CSS property rotation instead.
The legend property denoting the orientation, which is measured in degrees.

See Also:
IltObjectCustomization.getRotation()
Deprecated Since:
JTGO 3.5

PowerMaxValue

public static IlpIntegerKey PowerMaxValue
Deprecated. Please use CSS property powerMaxValue instead.
The legend property denoting the maximum power possible value for the antennas.

See Also:
IltObjectCustomization.getPowerMaxValue()
Deprecated Since:
JTGO 3.5

AntennaRadius

public static IlpIntegerKey AntennaRadius
Deprecated. Please use CSS property antennaRadius instead.
The legend property denoting the antenna size when the power value is maximum.

See Also:
IltObjectCustomization.getAntennaRadius()
Deprecated Since:
JTGO 3.5

AlphaBeamWidth

public static IlpFloatKey AlphaBeamWidth
Deprecated. Please use CSS property alphaBeamWidth instead.
The legend property denoting the alpha value used to achieve transparency effects when drawing the antenna beam width. It should be in the range of 0.0 to 1.0.

See Also:
IltObjectCustomization.getAlphaBeamWidth()
Deprecated Since:
JTGO 3.5

BeamWidthRadius

public static IlpIntegerKey BeamWidthRadius
Deprecated. Please use CSS property beamWidthRadius instead.
The legend property denoting the beamwidth radius of the antennas when the power value is maximum.

See Also:
IltObjectCustomization.getBeamWidthRadius()
Deprecated Since:
JTGO 3.5

AntennaVisible

public static IlpBooleanKey AntennaVisible
Deprecated. Please use CSS property antennaVisible instead.
The legend property denoting whether the graphical representation of the antennas are visible or not.

See Also:
IltObjectCustomization.isAntennaVisible()
Deprecated Since:
JTGO 3.5

BeamWidthVisible

public static IlpBooleanKey BeamWidthVisible
Deprecated. Please use CSS property beamWidthVisible instead.
The legend property denoting whether the graphical representation of the antenna beamwidths are visible or not.

See Also:
IltObjectCustomization.isBeamWidthVisible()
Deprecated Since:
JTGO 3.5

AntennaAntialiasing

public static IlpBooleanKey AntennaAntialiasing
Deprecated. Please use CSS property antennaAntialiasing instead.
The legend property denoting anti-aliasing.

See Also:
IltObjectCustomization.isAntennaAntialiasing()
Deprecated Since:
JTGO 3.5

BeamWidthBorderVisible

public static IlpBooleanKey BeamWidthBorderVisible
Deprecated. Please use CSS property beamWidthBorderVisible instead.
The legend property denoting whether the beamwidths are drawn with a border.

See Also:
IltObjectCustomization.isBeamWidthBorderVisible()
Deprecated Since:
JTGO 3.5

BTSEquipmentRadius

public static IlpIntegerKey BTSEquipmentRadius
Deprecated. Please use CSS property btsEquipmentRadius instead.
The legend property denoting the radius of the BTS equipment. Used when the BTS equipment is a IltNetworkElement. of type IltNetworkElement.Type.BTSEquipment.

See Also:
IltObjectCustomization.getBtsEquipmentRadius(), IltNetworkElement.Type.BTSEquipment
Deprecated Since:
JTGO 3.5
Constructor Detail

IltBTS

public IltBTS(String label,
              IltBTSAntenna[] antennas,
              IltNetworkElement equipment)
Deprecated. Containment relationships should be stored in a Datasource. Please use the DataSource API to declare the structure of your objects and use the BTS constructor that takes an identifier as argument.

Creates a new instance with a given label,an IltBTSAntenna array and an IltNetworkElement.

Parameters:
label - label for this object
antennas - an array of IltBTSAntenna
equipment - a IltNetworkElement.
See Also:
IltNetworkElement.Type.BTSEquipment
Deprecated Since:
JTGO 4.0

IltBTS

public IltBTS(String label,
              IltBTSAntenna[] antennas)
Deprecated. Containment relationships should be stored in a Datasource. Please use the DataSource API to declare the structure of your objects and use the BTS constructor that takes an identifier as argument.

Creates a new instance with a given label and an IltBTSAntenna array.

Parameters:
label - label for this object
antennas - an array of IltBTSAntenna
See Also:
IltDefaultDataSource
Deprecated Since:
JTGO 4.0

IltBTS

public IltBTS()
Creates a new instance with a generated identifier.

An ID is automatically generated using IlpIDGenerator.GetID().


IltBTS

public IltBTS(Object identifier)
Creates a new instance with a given identifier.

Parameters:
identifier - the identifier of this new instance

IltBTS

public IltBTS(IlpClass ilpClass,
              Object identifier)
Creates a new instance with a given class and identifier.

Parameters:
ilpClass - the business class of this new instance. Ilt must be subclass of IltBTS
identifier - the identifier of this new instance
Method Detail

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

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!

initializeBTS

protected void initializeBTS(IltBTSAntenna[] antennas)
This method should only be called by the constructors.

Internal method or field: do not use!

getOverviewObject

public IltStateHolder getOverviewObject()
Deprecated. BTS objects do not have an overview object.

Returns the overview object in the case of an IltBTS.

This method should not be called on IltBTS instances.

Specified by:
getOverviewObject in interface IltContainer
Deprecated Since:
JTGO 4.0

setOverviewObject

public void setOverviewObject(IltStateHolder overview)
Deprecated. BTS objects do not have an overview object.

Sets or replaces the overview object. It should not be called on IltBTS instances.

Specified by:
setOverviewObject in interface IltContainer
Deprecated Since:
JTGO 4.0

getDetailObjects

public IltChildrenModel getDetailObjects()
Deprecated. Containment relationships should be stored in a Datasource. Please use the DataSource API to declare the structure of your objects.

Returns the abstract model describing the set of detail objects.

Specified by:
getDetailObjects in interface IltContainer
See Also:
IltDefaultDataSource
Deprecated Since:
JTGO 4.0

setDetailObjects

public void setDetailObjects(IltChildrenModel details)
Deprecated. Containment relationships should be stored in a Datasource. Please use the DataSource API to declare the structure of your objects.

Sets or replaces the set of detail objects.

Specified by:
setDetailObjects in interface IltContainer
See Also:
IltDefaultDataSource
Deprecated Since:
JTGO 4.0

getStatePropagator

public IltStatePropagator getStatePropagator()
Deprecated. State propagation at the graphic level is not supported in the Network Component.

Returns the state propagation rules for the container.

Specified by:
getStatePropagator in interface IltContainer
Deprecated Since:
JTGO 4.0

setStatePropagator

public void setStatePropagator(IltStatePropagator propagator)
Deprecated. State propagation at the graphic level is not supported in the Network Component.

Sets the state propagation rules for the container.

Specified by:
setStatePropagator in interface IltContainer
Deprecated Since:
JTGO 4.0

applyTransform

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

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

getCenterPoint

protected IlvPoint getCenterPoint(IltGraphicManager manager,
                                  IltGraphic graphic)
Returns the shape graphic setting.

Specified by:
getCenterPoint in class IltObject
Internal method or field: 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 method or field: 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 method or field: 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 method or field: 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 method or field: 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.

Specified by:
createBase in class IltObject
See Also:
IltCompositeGraphic.createBase(IltcGraphicElementAggregate, IltObject), IltObject.createTinyBase(IltcGraphicElementAggregate)
Internal method or field: do not use!

getChildren

public Enumeration getChildren()
Returns the list of children objects, contained in this object. This method is overwritten by the objects which contain elements, such as shelves, card carriers and link sets.

Overrides:
getChildren in class IltObject
Internal method or field: 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 method or field: 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:

Specified by:
isValidPosition in class IltObject
Internal method or field: 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 method or field: 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 method or field: do not use!

createGraphic

public void createGraphic(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.

Ensures that this object has a graphic representation in a given IltGraphicManager. If no graphic representation exists in this view, an invisible graphic representation is created.

The graphic representations of the contained BTS items are also created.

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

Overrides:
createGraphic in class IltObject
Deprecated Since:
JTGO 3.5

removeGraphic

public void removeGraphic(IltGraphicManager manager)
Description copied from class: IltObject
Removes the graphic representation of this object from a given IltGraphicManager.

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

Overrides:
removeGraphic in class IltObject

initializeCreatedGraphic

public void initializeCreatedGraphic(IltGraphicManager manager,
                                     IltGraphic graphic)
This method must be called just after preCreateGraphic to initialize any needed property or graphic setting. This method is the one implemented by sub-classes of IltObject in order to execute their proper initialization.

Overrides:
initializeCreatedGraphic in class IltObject
Internal method or field: do not use!

getMappedForUserList

public ilog.util.internal.IlAVector getMappedForUserList()
Overrides:
getMappedForUserList in class IltObject
Internal method or field: do not use!


Copyright © 1996-2007 ILOG S.A. All rights reserved.   Documentation homepage.   . All Rights Reserved.