|
||||||||||
| 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.IltShelfItem
ilog.tgo.model.IltCardCarrier
public class IltCardCarrier
IltCardCarrier is the class for telecom objects that play the
role of card carrier cards inside telecom equipment. These shelf items can
be associated with slots in the same way as cards.
Card carriers hold a vertical set of slots that all have the same height. Cards can be associated with card carriers in the same way as shelves.
When using a children model to fill the card carrier, instances of
IlpShelfItemPosition can be used as parent-child relations.
| Nested Class Summary | |
|---|---|
static class |
IltCardCarrier.Type
This enumeration lists the types of CardCarriers. |
| Nested classes/interfaces inherited from class ilog.tgo.model.IltObject |
|---|
IltObject.ListPrimaryStateStyleValueProvider, IltObject.LogicalType, IltObject.TinyType |
| Field Summary | |
|---|---|
static int |
_defaultBottomSpacing
Deprecated. Please use DEFAULT_BOTTOM_SPACING instead. |
static IltAttribute |
BottomSpacingAttribute
Attribute to define the size of the visible bottom part of a card carrier. |
static int |
DEFAULT_BOTTOM_SPACING
Default size of the visible bottom part of a card carrier. |
static int |
DEFAULT_SLOT_COUNT
|
static IltObjectInfo |
metainfo
Contains metainformation about this IltObject class. |
static IltAttribute |
SlotCountAttribute
Attribute to manage the number of slots. |
static IltAttribute |
TypeAttribute
Attribute used to define the type of the Card Carrier. |
| Fields inherited from class ilog.tgo.model.IltShelfItem |
|---|
DirectionAttribute, StateIconsStackingDirection, VerticalLabelStacksGlyphs |
| Fields inherited from interface ilog.cpl.model.IlpAttributeValueHolder |
|---|
VALUE_NOT_SET |
| Constructor Summary | |
|---|---|
IltCardCarrier(IlpClass ilpClass,
Object identifier)
Creates a new instance of IltCardCarrier with a given class
and identifier. |
|
IltCardCarrier(IltCardCarrier.Type type,
IltObjectState state,
int slotCount)
Creates a new card carrier. |
|
IltCardCarrier(IltObjectState state,
int slotCount)
Creates a new card carrier with the Standard type. |
|
IltCardCarrier(Object identifier)
Creates a new card carrier with an identifier. |
|
| Method Summary | |
|---|---|
void |
checkItem(IltObject item,
IlpShelfItemPosition position)
Check the position for a given item, verifying if indexes and spans are valid, and also checking if the item can fit into the container. |
void |
computeGraphic(IltGraphicManager manager,
IlvRect rect)
Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation
visible. |
protected void |
copyFrom(IltObject o)
Copies the attributes from an original object. |
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. |
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. |
int |
findItem(IltObject item)
Deprecated. Please retrieve the object position using getPosition. |
int |
getBottomSpacing()
Gets the current size of the visible bottom part. |
Enumeration |
getChildren()
Deprecated. In the future, relationships will only be defined at the datasource level. |
IltChildrenModel |
getDetailObjects()
Deprecated. Containment relationships should be declared at the Datasource level. |
static IltObjectInfo |
GetIlpClass()
Returns the IlpClass corresponding to this Java class. |
IltObject |
getItem(int slotIndex)
Deprecated. Containment relationships should be declared and retrieved at the Datasource level. |
IltObject |
getItem(int slotXIndex,
int slotYIndex)
Returns the child item occupying the slot defined by slotXIndex and slotYIndex. |
IlpShelfItemPosition |
getItemPosition(IltObject item)
Returns the position of the child object relative to its parent, based on both x and y slot positioning. |
IlvRect |
getItemRect(IltGraphicManager manager,
IltObject item)
Access the dimension of a given child item in the given manager. |
Enumeration |
getItems()
Deprecated. Containment relationships should be declared and retrieved at the Datasource level. |
Enumeration |
getItems(int slotIndex,
float slotSpan)
Deprecated. Containment relationships should be declared and retrieved at the Datasource level. |
Enumeration |
getItems(int slotXIndex,
float slotXSpan,
int slotYIndex,
float slotYSpan)
Returns an Enumeration of the child items
(IltObject instances) in the container that are fully
or partially covered by the given area defined by
slotXIndex, slotYIndex,
slotXSpan and slotYSpan. |
float |
getItemSpan(int slotIndex)
Deprecated. Span information is part of the card position. Please use getPosition on the card that you are querying
to retrieve the span information. |
IltStateHolder |
getOverviewObject()
Deprecated. Containment relationships should be declared at the Datasource level. |
int |
getSlotCount()
Access the total number of slots that the container has. |
float |
getSlotSpanX(int xIndex,
int yIndex)
Retrieves the number of slots spanned through the x
axis by the children occupying the given slot x and
y position. |
float |
getSlotSpanY(int xIndex,
int yIndex)
Retrieves the number of slots spanned through the y
axis by the children occupying the given slot x and
y position. |
IltStatePropagator |
getStatePropagator()
Deprecated. State propagation at the graphic level is not supported in the Network and Equipment Components. |
IltCardCarrier.Type |
getType()
Returns the Type of the CardCarrier. |
protected IlpAttribute |
getTypeAttribute()
Returns the attribute that stores type information |
protected void |
initializeCardCarrier(int slotCount)
This method must only be called in 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 |
isShelfItemContainer()
Returns true if this item can contain other shelf items. |
protected void |
recreateChildren(ilog.tgo.model.internal.IltSlotArray sArray)
|
void |
removeAllItems()
Deprecated. Containment relationships should be declared and retrieved at the Datasource level. |
void |
removeGraphic(IltGraphicManager manager)
Removes the graphic representation of this object from a given IltGraphicManager. |
void |
removeGraphic(IltGraphicManager manager,
IltCompositeGraphic graphic)
|
boolean |
removeItem(IltObject item)
Deprecated. Containment relationships should be declared and retrieved at the Datasource level. |
void |
setAttributeValue(IlpAttribute attribute,
Object value)
Sets the value of an attribute of this object. |
void |
setBottomSpacing(int bottomSpacing)
Changes the size of the visible bottom part. |
void |
setDetailObjects(IltChildrenModel details)
Deprecated. Containment relationships should be declared at the Datasource level. |
void |
setDirection(int containerDirection)
Deprecated. Please use setAttributeValue method to
change the IltCardCarrier.DirectionAttribute
instead. The direction has changed from
IlvDirection to IlpDirection. |
void |
setDirection(int containerDirection,
int itemsDirection)
Deprecated. Whenever the direction of a card carrier changes, the directions of all its children change accordingly. Update each child direction individually by using the method setAttributeValue to change the
IltCardCarrier.DirectionAttribute of each
child object. The direction has changed from
IlvDirection to IlpDirection. |
protected void |
setDirectionAndShape(int containerDirection,
int itemsDirection)
Deprecated. |
void |
setItem(int slotXIndex,
float slotXSpan,
int slotYIndex,
float slotYSpan,
IltObject item)
Adds a child item to the container at a given position and span. |
void |
setItem(int slotIndex,
IltObject item)
Deprecated. Containment relationships should be declared at the Datasource level. Please insert your card in the datasource, setting it as child of this card carrier. It will also be necessary to define its position within the card carrier. You can do this, by setting the card position attribute to a shelf item position IlpShelfItemPosition |
void |
setItem(int slotIndex,
IltObject item,
float slotSpan)
Deprecated. Containment relationships should be declared and retrieved at the Datasource level. Please add your object to the datasource as a child of this card carrier and set its position, as a IlpShelfItemPosition
using the method setPosition at the object
level or at the component view level. |
void |
setItem(int slotXIndex,
int slotYIndex,
IltObject item)
Adds a child item to the container at a given position; any other children accupying the given position (or even part of it) are removed. |
void |
setOverviewObject(IltStateHolder overview)
Deprecated. Containment relationships should be declared at the Datasource level. In case of card carriers, the overview object can not be changed, as it is the card carrier instance itself. |
void |
setShapeGraphicSetting(IltGraphic graphic,
Object newShape)
Sets the graphic settings responsible for the shape of the object. |
void |
setShapeInManager(IltGraphicManager manager,
IltGraphic graphic,
IlvRect shape)
Sets the shape of this card carrier in the given manager and recalculates the contained shelf items sizes. |
void |
setSlotCount(int slotCount)
Changes the number of slots in this card carrier. |
void |
setStatePropagator(IltStatePropagator propagator)
Deprecated. State propagation at the graphic level is not supported in the Network and Equipment Components. |
void |
setType(IltCardCarrier.Type type)
Changes the Type of the CardCarrier. |
void |
updateFrom(IltObject other)
Updates the local cache of attributes stored in getObjectAttribute(). |
protected void |
updateSlotCount(int oldSlotCount,
int newSlotCount)
|
| 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 |
|---|
public static IltObjectInfo metainfo
IltObject class.
public static int _defaultBottomSpacing
DEFAULT_BOTTOM_SPACING instead.
public static int DEFAULT_BOTTOM_SPACING
public static IltAttribute TypeAttribute
Attribute name: type
Value type: IltCardCarrier.Type.
IltCardCarrier.Typepublic static IltAttribute SlotCountAttribute
Attribute name: slotCount.
Value type: Integer.
public static IltAttribute BottomSpacingAttribute
Attribute name: bottomSpacing.
Value type: Integer.
public static int DEFAULT_SLOT_COUNT
| Constructor Detail |
|---|
public IltCardCarrier(Object identifier)
identifier - the identifier of this new instance
public IltCardCarrier(IlpClass ilpClass,
Object identifier)
IltCardCarrier with a given class
and identifier.
ilpClass - the business class of this new instance. It must be a
subclass of IltCardCarrieridentifier - the identifier of this new instance
public IltCardCarrier(IltObjectState state,
int slotCount)
setType method.
state - The semantic state of the card carrierslotCount - The number of vertical slots of equal size
public IltCardCarrier(IltCardCarrier.Type type,
IltObjectState state,
int slotCount)
type - The type of the card carrierstate - The semantic state of the card carrierslotCount - The number of vertical slots of equal size| Method Detail |
|---|
public static IltObjectInfo GetIlpClass()
protected IlpAttribute getTypeAttribute()
IltShelfItem
getTypeAttribute in class IltShelfItem
protected void initializeObject(IltObjectState state,
String name)
initializeObject in class IltShelfItemIltObject.initializeObject(ilog.tgo.model.IltObjectState, java.lang.String)protected void initializeCardCarrier(int slotCount)
public void updateFrom(IltObject other)
IltObject
updateFrom in class IltObjectprotected void copyFrom(IltObject o)
IltObject
copyFrom in class IltObjectIltObject.cloneForRendering(boolean)protected void recreateChildren(ilog.tgo.model.internal.IltSlotArray sArray)
public IltCardCarrier.Type getType()
public void setType(IltCardCarrier.Type type)
public void setBottomSpacing(int bottomSpacing)
public int getBottomSpacing()
public void setSlotCount(int slotCount)
slotCount - the new number of slotspublic int getSlotCount()
getSlotCount in interface IltShelfItemContainerx and
y dimensions
protected void updateSlotCount(int oldSlotCount,
int newSlotCount)
public boolean isShelfItemContainer()
IltShelfItemtrue if this item can contain other shelf items.
isShelfItemContainer in class IltShelfItem
public void setShapeGraphicSetting(IltGraphic graphic,
Object newShape)
IltShelfItem
setShapeGraphicSetting in class IltShelfItem
public void setShapeInManager(IltGraphicManager manager,
IltGraphic graphic,
IlvRect shape)
public void createGraphic(IltGraphicManager manager)
IlpNetwork, is enough to make its graphic representation
visible.
The graphic representations of the contained shelf items are also created.
createGraphic in class IltObject
public void computeGraphic(IltGraphicManager manager,
IlvRect rect)
IlpNetwork, is enough to make its graphic representation
visible.
public ilog.tgo.graphic.internal.IltGraphicUpdate createPositionUpdate(Object position,
Object positionInManager)
null, the position/shape set will be
the default value.
createPositionUpdate in class IltShelfItemposition - the shape in stationary coordinatespositionInManager - the shape in manager coordinates (takes into
account the logical zoom transformer)public void removeGraphic(IltGraphicManager manager)
IltObjectIltGraphicManager.
Note that this method is not supposed to be used when this
IltObject is in a DataSource.
removeGraphic in class IltObject
public void removeGraphic(IltGraphicManager manager,
IltCompositeGraphic graphic)
public void initializeCreatedGraphic(IltGraphicManager manager,
IltGraphic graphic)
IltObject
initializeCreatedGraphic in class IltObjectpublic ilog.tgo.graphic.internal.base.IltBaseElement createBase(IltcGraphicElementAggregate root)
IltObject
createBase in class IltObjectIltCompositeGraphic.createBase(IltcGraphicElementAggregate, IltObject),
IltObject.createTinyBase(IltcGraphicElementAggregate)public IltStateHolder getOverviewObject()
IltShelf.
getOverviewObject in interface IltContainerpublic void setOverviewObject(IltStateHolder overview)
It should not be called on IltShelf instances.
setOverviewObject in interface IltContainerpublic IltChildrenModel getDetailObjects()
getDetailObjects in interface IltContainerIltDefaultDataSourcepublic void setDetailObjects(IltChildrenModel details)
Note that the set of detail objects can change dynamically, see
class IltChildrenModelListener.
To be able to use the setItem, removeItem
and removeItems methods, details must be an
instance of a subclass of IltDefaultChildrenModel.
setDetailObjects in interface IltContainerIltDefaultDataSourcepublic IltStatePropagator getStatePropagator()
getStatePropagator in interface IltContainerpublic void setStatePropagator(IltStatePropagator propagator)
setStatePropagator in interface IltContainer