|
||||||||||
| 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.IltCard
public class IltCard
IltCard is the class for telecom objects that play the role of
cards of telecom equipment.
A card can be either contained in a shelf or in a card-carrier card.
A card can strictly occupy one slot or can span several slots in its container. It can bear states, statuses and alarms like any telecom object.
When a card is created, it is associated with a beginning slot (at some integer position in the shelf or card-carrier card). The number of slots occupied by the card, which is not necessarily an integer, must be provided.
IltCard is also a container for IltCardItem
objects.
| Nested Class Summary | |
|---|---|
static class |
IltCard.Type
This enumeration lists the types of cards. |
| Nested classes/interfaces inherited from class ilog.tgo.model.IltObject |
|---|
IltObject.ListPrimaryStateStyleValueProvider, IltObject.LogicalType, IltObject.TinyType |
| Field Summary | |
|---|---|
protected ilog.tgo.model.internal.IltCardItemContainerSupport |
_container
Contains the ShelfItemContainer characteristics of this composite card. |
static IltObjectInfo |
metainfo
Contains metainformation about this IltObject class. |
static IltAttribute |
TypeAttribute
Attribute used to define the type of the shelf item. |
| Fields inherited from class ilog.tgo.model.IltShelfItem |
|---|
DirectionAttribute, StateIconsStackingDirection, VerticalLabelStacksGlyphs |
| Fields inherited from interface ilog.cpl.model.IlpAttributeValueHolder |
|---|
VALUE_NOT_SET |
| Constructor Summary | |
|---|---|
IltCard(IlpClass ilpClass,
Object identifier)
Creates a new card with a class and an identifier. |
|
IltCard(IltCard.Type type,
IltObjectState state,
String label)
Creates a new card. |
|
IltCard(IltObjectState state)
Creates a new card without a label and with the standard type. |
|
IltCard(IltObjectState state,
String label)
Creates a new card with the standard type. |
|
IltCard(Object identifier)
Creates a new card with an identifier. |
|
| Method Summary | |
|---|---|
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. |
IlvPoint |
getChildPosition(IltCardItem cardItem)
Deprecated. Please use getPosition in the card item
itself, or in the component view where it is being displayed. |
Enumeration |
getChildren()
Returns the list of child 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. Container relationships should be declared at the data source level. |
static IltObjectInfo |
GetIlpClass()
Returns the IlpClass corresponding to this Java class. |
int |
getItemCount()
Deprecated. Container relationships should be declared and retrieved at the data source level. |
Enumeration |
getItems()
Deprecated. Container relationships should be declared and retrieved at the data source level. |
IltStateHolder |
getOverviewObject()
Deprecated. Container relationships should be declared at the data source level. |
IlvPoint |
getParentPosition(IltGraphicManager manager,
IltGraphic graphic)
Deprecated. Please retrieve the parent object and use getPosition instead. |
IlpRelativePoint |
getRelativePosition(IltGraphicManager manager,
IlvPoint viewPos)
Converts the absolute position ( IlvPoint) of a card item into
a relative position. |
IltStatePropagator |
getStatePropagator()
Deprecated. State propagation at the graphic level is not supported in the network component. |
IltCard.Type |
getType()
Returns the type of the card. |
protected IlpAttribute |
getTypeAttribute()
Returns the attribute that stores type information |
IlvPoint |
getViewPosition(IltGraphicManager manager,
IltCardItem item)
Converts the relative position ( IlpRelativePoint) of a card
item into a view position. |
protected void |
initializeObject(IltObjectState state,
String name)
This method is only called by the constructor. |
void |
removeAllItems()
Deprecated. Container relationships should be declared and retrieved at the data source level. |
void |
removeGraphic(IltGraphicManager manager)
Deprecated. Removing an object from the data source that it is contained in is enough to make its graphic representation disappear. |
void |
removeItem(IltCardItem item)
Deprecated. Container relationships should be declared and retrieved at the data source level. |
void |
setAttributeValue(IlpAttribute attribute,
Object value)
Sets the value of an attribute of this object. |
void |
setDetailObjects(IltChildrenModel details)
Deprecated. Container relationships should be declared at the data source level. |
void |
setDirection(int containerDirection)
Deprecated. Please use setAttributeValue using the attribute
IltCard.DirectionAttribute |
void |
setItem(IltCardItem item,
IlvPoint pos)
Deprecated. Container relationships should be declared at the data source level. Please insert your card item in the data source, setting it as child of this card. It will also be necessary to define its position within the card. You can do this, by setting the card item position attribute to a relative point IlpRelativePoint. |
void |
setOverviewObject(IltStateHolder overview)
Deprecated. Container relationships should be declared at the data source level. In the case of cards, the overview object cannot be changed, as it is the card instance itself. |
void |
setStatePropagator(IltStatePropagator propagator)
Deprecated. State propagation at the graphic level is not supported in the network component. |
void |
setType(IltCard.Type type)
Changes the type of the card. |
| 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 IltAttribute TypeAttribute
Attribute name: type
Value type: IltCard.Type.
IltCard.Typeprotected transient ilog.tgo.model.internal.IltCardItemContainerSupport _container
| Constructor Detail |
|---|
public IltCard(Object identifier)
The name can be set afterwards with setName function.
The type can be modified afterwards with the setType method.
identifier - The identifier of this new instance.
public IltCard(IlpClass ilpClass,
Object identifier)
The name can be set afterwards with the setName function.
The type can be modified afterwards with the setType method.
ilpClass - The business class of this new instance. It must be a
subclass of IltCard.identifier - The identifier of this new instance.public IltCard(IltObjectState state)
The name can be set afterwards with setName function.
The type can be modified afterwards with the setType method.
state - The semantic state of the card.
public IltCard(IltObjectState state,
String label)
The type can be modified afterwards with the setType
method.
state - The semantic state of the card.label - The name that will appear on the card.
public IltCard(IltCard.Type type,
IltObjectState state,
String label)
type - The type of the card.state - The semantic state of the card.label - The name that will appear on the card.| Method Detail |
|---|
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)public static IltObjectInfo GetIlpClass()
IlpClass corresponding to this Java class.
Here the IlpClass interface is implemented by
IltObjectInfo.
public static IltLegend GetClassLegend()
public void removeGraphic(IltGraphicManager manager)
IltGraphicManager.
removeGraphic in class IltObjectpublic Enumeration getChildren()
getChildren in class IltObjectEnumeration of IltStateHolder
objects.
public void setAttributeValue(IlpAttribute attribute,
Object value)
VALUE_NOT_SET for the
value argument.
setAttributeValue in interface IlpAttributeValueHoldersetAttributeValue in class IltShelfItemattribute - The attribute for which the value is being set.value - The new value of the attribute or
VALUE_NOT_SET to remove the value
of the attribute.
IllegalArgumentException - if the attribute cannot have
its value modified.public ilog.tgo.graphic.internal.base.IltBaseElement createBase(IltcGraphicElementAggregate root)
createBase in class IltObjectIltCompositeGraphic.createBase(IltcGraphicElementAggregate, IltObject),
IltGraphicRepresentationStyle,
IltBaseElement,
IltObject.createTinyBase(IltcGraphicElementAggregate)public IltChildrenModel getDetailObjects()
getDetailObjects in interface IltContainerIltDefaultDataSourcepublic void setDetailObjects(IltChildrenModel details)
Note that the set of a new detail object can be dynamic, 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 IltContainerdetails - The new detail object to be set, it must be a
subclass of the IltDefaultChildrenModel
classIltDefaultDataSourcepublic IltStateHolder getOverviewObject()
getOverviewObject in interface IltContainerpublic void setOverviewObject(IltStateHolder overview)
IltCard instance is given by the instance itself,
this method should not be called and will throw a runtime exception.
setOverviewObject in interface IltContaineroverview - The new overview object to be set.public IltStatePropagator getStatePropagator()
getStatePropagator in interface IltContainerpublic void setStatePropagator(IltStatePropagator propagator)
setStatePropagator in interface IltContainerpropagator - The new state propagator set of rules.
public void setItem(IltCardItem item,
IlvPoint pos)
IlpRelativePoint.
The position is relative to the container origin.
The container origin depends on the currently set direction:
if the container direction is Top, the origin is the
top-left corner of the base;
if the container direction is Right, the origin is the
top-right corner of the base;
if the container direction is Bottom, the origin is the
bottom-right corner of the base;
if the container direction is Left, the origin is the
bottom-left corner of the base.
If the container already has a graphic representation,
computeGraphic will automatically be called on the child item
in all the managers that include the container.
setItem in interface ilog.tgo.model.internal.IltCardItemContaineritem - Item inserted in the container.pos - Position relative to the container origin.IltDefaultDataSource,
IlpRelativePointpublic Enumeration getItems()
getItems in interface ilog.tgo.model.internal.IltCardItemContainerEnumeration containing all child items.IltDefaultDataSourcepublic void removeItem(IltCardItem item)
removeItem in interface ilog.tgo.model.internal.IltCardItemContaineritem - The object to be removed from the container.IltDefaultDataSourcepublic void removeAllItems()
removeAllItems in interface ilog.tgo.model.internal.IltCardItemContainerIltDefaultDataSourcepublic int getItemCount()
getItemCount in interface ilog.tgo.model.internal.IltCardItemContainerIltDefaultDataSource
public IlvPoint getParentPosition(IltGraphicManager manager,
IltGraphic graphic)
getPosition instead.
getParentPosition in interface ilog.tgo.model.internal.IltCardItemContainermanager - The graphic manager holding the object representation.graphic - The graphic associated to the object.
public IlvPoint getChildPosition(IltCardItem cardItem)
getPosition in the card item
itself, or in the component view where it is being displayed.
getChildPosition in interface ilog.tgo.model.internal.IltCardItemContainercardItem - The given card item.
null if it could not be found.IltObject.getPosition(),
IlpGraphView.getPosition(ilog.cpl.model.IlpRepresentationObject)
public IlvPoint getViewPosition(IltGraphicManager manager,
IltCardItem item)
IlpRelativePoint) of a card
item into a view position.
getViewPosition in interface ilog.tgo.model.internal.IltCardItemContainermanager - The graphic manager for the objects.item - The item containing the relative position.
public IlpRelativePoint getRelativePosition(IltGraphicManager manager,
IlvPoint viewPos)
IlvPoint) of a card item into
a relative position.
getRelativePosition in interface ilog.tgo.model.internal.IltCardItemContainermanager - The graphic manager for the objects.viewPos - The absolute position (view position) for the item.
public void setDirection(int containerDirection)
setAttributeValue using the attribute
IltCard.DirectionAttribute
IltObject.Direction.This method should be called when all card items have been inserted in the container and after each change in the container content.
The direction of the items are set accordingly, to meet the new position
of the container.
This method changes the IltObject.Direction style
value, which is computed through a style value provider, based
on the IltShelf.DirectionAttribute. Note that using
this method will override the style value provider of the shelf
and all its children.
Multiple context is not supported within this method, all legend values are computed and set based on the default context only.
This method is provided only to support IltShelf.setDirection
and IltCardCarrier.setDirection, that are deprecated.
setDirection in interface ilog.tgo.model.internal.IltCardItemContainercontainerDirection - either IlvDirection.Top
or IlvDirection.Bottom
or IlvDirection.Left
or IlvDirection.Rightpublic IltCard.Type getType()
public void setType(IltCard.Type type)
|
||||||||||
| PREV CLASS Documentation homepage NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||