public class IltCardCarrier extends IltShelfItem implements IltShelfItemContainer, IltContainer
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.
Modifier and Type | Class and Description |
---|---|
static class |
IltCardCarrier.Type
This enumeration lists the types of CardCarriers.
|
IltObject.ListPrimaryStateStyleValueProvider, IltObject.LogicalType, IltObject.TinyType
Modifier and Type | Field and Description |
---|---|
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.
|
DirectionAttribute, StateIconsStackingDirection, VerticalLabelStacksGlyphs
_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
VALUE_NOT_SET
Constructor and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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,
double slotSpan)
Deprecated.
Containment relationships should be declared and retrieved
at the Datasource level.
|
Enumeration |
getItems(int slotXIndex,
double slotXSpan,
int slotYIndex,
double 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 . |
double |
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.
|
double |
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. |
double |
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,
double slotXSpan,
int slotYIndex,
double 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,
double 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) |
applyTransform, CheckDirection, copyFrom, defaultShape, getBaseRectangle, getCenterPoint, GetClassLegend, getContainer, getDefaultLabelPosition, getLabelDirection, getLabelDirection, getLabelDirection, getMappedForUserList, getOutermostParentGraphic, getShape, getShape, getShapeInManager, isItemMoveable, isValidPosition, resetLabelDirection, resetLabelDirection, restoreVisibility, setAutomaticDecorationsDirection, setBaseRectangle, setCenterPoint, setContainer, setLabelDirection, setLabelDirection, setProperty, setShape, setShape, setShape, setShapeInManagerGraphicSetting, transformPosition, updateShapeGraphicSettingInManager, usingDefaultShape
__getIlpObject, addGraphicChangedListener, addStateChangedListener, applyTransform, applyTransform, applyTransform, applyTransformInManager, clearState, cloneForRendering, computeGraphic, computeGraphic, computeGraphic, computeGraphic, computeGraphic, computeGraphicAtPosition, createTinyBase, debug, endDelayingComputeGraphic, EndDelayingComputeGraphic, fireAllGraphicChanged, fireGraphicChanged, ForceInit, forgetShapeGraphicSettingInManager, FromGraphic, getAlarmState, getAttacherInfo, getAttacherInfoController, getAutomaticDecorationsDirection, getBaseRectangleInManager, GetBaseStyleMapping, getCenterPoint, getCenterPointInManager, 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, setAutomaticDecorationsDirection, setBaseRectangleInManager, setCenterPoint, setCenterPoint, setCenterPointInManager, setEditable, setGraphic, setGraphicSetting, setGraphicSetting, setGraphicSetting, setGraphicSettings, setIlpClass, setLabel, setLabelOffset, setLabelOffset, setLabelPosition, setLabelPosition, setLegend, setLogicalType, setName, setObjectState, setPosition, SetPropertyTransient, setSelected, setSelectedInternal, setState, setState, setTinyType, setVisible, startDelayingComputeGraphic, StartDelayingComputeGraphic, startVisibility
addAttributeValueListener, fireEvent, getAttributeGroup, getAttributeValue, getAttributeValue, getAttributeValueByName, getIdentifier, getIlpClass, getLocalAttributeValues, getObjectSupport, hasAttributeValue, removeAttributeValueListener, setAttributeValue, setAttributeValueByName, setLocalAttributeValues, setObjectSupport, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
setObjectState
addStateChangedListener, getObjectState, removeStateChangedListener
public static IltObjectInfo metainfo
IltObject
class.@Deprecated 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.Type
public 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
public IltCardCarrier(Object identifier)
identifier
- the identifier of this new instancepublic 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 IltCardCarrier
identifier
- the identifier of this new instancepublic IltCardCarrier(IltObjectState state, int slotCount)
setType
method.state
- The semantic state of the card carrierslotCount
- The number of vertical slots of equal sizepublic 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 sizepublic static IltObjectInfo GetIlpClass()
protected IlpAttribute getTypeAttribute()
IltShelfItem
getTypeAttribute
in class IltShelfItem
protected void initializeObject(IltObjectState state, String name)
initializeObject
in class IltShelfItem
IltObject.initializeObject(ilog.tgo.model.IltObjectState, java.lang.String)
protected void initializeCardCarrier(int slotCount)
public void updateFrom(IltObject other)
IltObject
updateFrom
in class IltObject
protected void copyFrom(IltObject o)
IltObject
copyFrom
in class IltObject
IltObject.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 IltShelfItemContainer
x
and
y
dimensionsprotected void updateSlotCount(int oldSlotCount, int newSlotCount)
public boolean isShelfItemContainer()
IltShelfItem
true
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)
@Deprecated 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
@Deprecated 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 IltShelfItem
position
- the shape in stationary coordinatespositionInManager
- the shape in manager coordinates (takes into
account the logical zoom transformer)public void removeGraphic(IltGraphicManager manager)
IltObject
IltGraphicManager
.
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 IltObject
public ilog.tgo.graphic.internal.base.IltBaseElement createBase(IltcGraphicElementAggregate root)
IltObject
createBase
in class IltObject
IltCompositeGraphic.createBase(IltcGraphicElementAggregate, IltObject)
,
IltObject.createTinyBase(IltcGraphicElementAggregate)
@Deprecated public IltStateHolder getOverviewObject()
IltShelf
.getOverviewObject
in interface IltContainer
@Deprecated public void setOverviewObject(IltStateHolder overview)
It should not be called on IltShelf
instances.
setOverviewObject
in interface IltContainer
@Deprecated public IltChildrenModel getDetailObjects()
getDetailObjects
in interface IltContainer
IltDefaultDataSource
@Deprecated public 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 IltContainer
IltDefaultDataSource
@Deprecated public IltStatePropagator getStatePropagator()
getStatePropagator
in interface IltContainer
@Deprecated public void setStatePropagator(IltStatePropagator propagator)
setStatePropagator
in interface IltContainer
@Deprecated public Enumeration getChildren()
getChildren
in class IltObject
@Deprecated public void setItem(int slotIndex, IltObject item)
IlpShelfItemPosition
If the container already has a graphic representation,
computeGraphic
will automatically be called on the item
in all the managers that include the container.
setItem
in interface IltShelfItemContainer
slotIndex
- Slot number in this container where the item will be set.item
- Item inserted in the container.IltDefaultDataSource
,
IlpShelfItemPosition
public void setItem(int slotXIndex, int slotYIndex, IltObject item)
If the container already has a graphic representation,
computeGraphic
method will be automatically invoked
on every manager that contains it.
The container positioning is based on a bidimensional matrix where
each child is placed based on a origin point (x and y coordinates)
plus a bidimensional span (x span and y span).
This method considers span equals to 1.0
, which means
no span at all.
NOTE: This method throws an
UnsupportedOperationException
, it should not be called
from a card carrier, and should not be documented.
slotXIndex
- The slot index for the X
coordinateslotYIndex
- The slot index for the Y
coordinateitem
- The child object being inserted in the containerUnsupportedOperationException
- always.public void setItem(int slotXIndex, double slotXSpan, int slotYIndex, double slotYSpan, IltObject item)
The child object will start at slotXIndex
and
slotYIndex
, expanding over other slots according to
slotXSpan
and slotYSpan
attributes.
The container positioning is based on a bidimensional matrix where each child is placed based on a origin point (x and y coordinates) plus a bidimensional span (x span and y span).
Span is a positive double representing a fraction of a slot, with
1.0
being a single slot, 1.5
meaning the
initial slot plus half of the neighbor slot and so forth.
Any child occupying the position defined by the new child will
be removed from the container.
If the container already has a graphic representation,
computeGraphic
method will be automatically invoked
on every manager that contains it.
NOTE: This method throws an
UnsupportedOperationException
, it should not be called
from a card carrier, and should not be documented.
slotXIndex
- The slot index for the X
coordinateslotXSpan
- The slot spanning for the X
coordinateslotYIndex
- The slot index for the Y
coordinateslotYSpan
- The slot spanning for the Y
coordinateitem
- The child object being inserted in the containerUnsupportedOperationException
- always.@Deprecated public boolean removeItem(IltObject item)
item
child item of the container. Removes all
the graphic representations of the given item if any.removeItem
in interface IltShelfItemContainer
true
if the item was found in the container,
otherwise it returns false
.IltDefaultDataSource
@Deprecated public void removeAllItems()
removeAllItems
in interface IltShelfItemContainer
IltDefaultDataSource
public IltObject getItem(int slotXIndex, int slotYIndex)
slotXIndex
and slotYIndex
.
The slot might be partially occupied by the returned item
(if the corresponding slot span are not an integer).
NOTE: This method throws an
UnsupportedOperationException
, it should not be called
from a card carrier, and should not be documented.
slotXIndex
- The slot index for the X
coordinateslotYIndex
- The slot index for the Y
coordinateUnsupportedOperationException
- always.@Deprecated public Enumeration getItems()
getItems
in interface IltShelfItemContainer
Enumeration
of IltObject
child itemsIltDefaultDataSource
public Enumeration getItems(int slotXIndex, double slotXSpan, int slotYIndex, double slotYSpan)
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
.
NOTE: This method throws an
UnsupportedOperationException
, it should not be called
from a card carrier, and should not be documented.slotXIndex
- The slot index for the X
coordinateslotXSpan
- Positive non-zero double representing the slot
spanning for the X
coordinateslotYIndex
- The slot index for the Y
coordinateslotYSpan
- Positive non-zero double representing the slot
spanning for the Y
coordinateUnsupportedOperationException
- always.public double getSlotSpanX(int xIndex, int yIndex)
x
axis by the children occupying the given slot x
and
y
position.
If no item is present in the slot, it returns the number of
contiguous empty slots around (x
axis) the given slot.
NOTE: This method throws an
UnsupportedOperationException
, it should not be called
from a card carrier, and should not be documented.
xIndex
- The x
slot coordinateyIndex
- The y
slot coordinatex
axisUnsupportedOperationException
- always.public double getSlotSpanY(int xIndex, int yIndex)
y
axis by the children occupying the given slot x
and
y
position.
If no item is present in the slot, it returns the number of
contiguous empty slots around (y
axis) the given slot.
NOTE: This method throws an
UnsupportedOperationException
, it should not be called
from a card carrier, and should not be documented.
xIndex
- The x
slot coordinateyIndex
- The y
slot coordinatey
axisUnsupportedOperationException
- always.public IlpShelfItemPosition getItemPosition(IltObject item)
x
and y
slot positioning.
NOTE: This method throws an
UnsupportedOperationException
; it should not be called
from a card carrier, and should not be documented.getItemPosition
in interface IltShelfItemContainer
item
- The child object of which to retrieve the slot positionIlpShelfItemPosition
object containing
positioning information, or null
if
item
does not belong to the containerUnsupportedOperationException
- always.public IlvRect getItemRect(IltGraphicManager manager, IltObject item)
getItemRect
in interface IltShelfItemContainer
manager
- The container's graphic manageritem
- The child object@Deprecated public void setDirection(int containerDirection)
setAttributeValue
method to
change the IltCardCarrier.DirectionAttribute
instead. The direction has changed from
IlvDirection
to IlpDirection
.DirectionAttribute
for the card carrier.
The direction of all child objects is affected and
changed accordingly.
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 style values are computed and set based on the default context only.
setDirection
in interface IltShelfItemContainer
containerDirection
- Either IlvDirection.Top
,
or IlvDirection.Bottom
,
or IlvDirection.Left
,
or IlvDirection.Right
IltShelfItem.DirectionAttribute
@Deprecated public void setDirection(int containerDirection, int itemsDirection)
setAttributeValue
to change the
IltCardCarrier.DirectionAttribute
of each
child object. The direction has changed from
IlvDirection
to IlpDirection
.DirectionAttribute
for the card
carrier.
All child objects are changed to the given direction.
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 style values are computed and set based on the default context only.
setDirection
in interface IltShelfItemContainer
containerDirection
- Either IlvDirection.Top
,
or IlvDirection.Bottom
,
or IlvDirection.Left
,
or IlvDirection.Right
itemsDirection
- Either IlvDirection.Top
,
or IlvDirection.Bottom
,
or IlvDirection.Left
,
or IlvDirection.Right
IltShelfItem.DirectionAttribute
@Deprecated protected void setDirectionAndShape(int containerDirection, int itemsDirection)
public void checkItem(IltObject item, IlpShelfItemPosition position)
checkItem
in interface IltShelfItemContainer
item
- The new item being checked.position
- The (relative) position where the item is being added.IllegalArgumentException
- If the item has invalid position. All
details are wrapped into the exception.public void setAttributeValue(IlpAttribute attribute, Object value)
VALUE_NOT_SET
for the value
argument.setAttributeValue
in interface IlpAttributeValueHolder
setAttributeValue
in class IltShelfItem
attribute
- The attribute of which the value is set.value
- The new value of the attribute or
VALUE_NOT_SET
to remove the value
of the attribute.IllegalArgumentException
- If the attribute can not have
its value modified.@Deprecated public void setItem(int slotIndex, IltObject item, double slotSpan)
IlpShelfItemPosition
using the method setPosition
at the object
level or at the component view level.slotIndex
and spans slotSpan
slots. The child
items previously occupying the slots used by item
are removed from the container.
If the container already has a graphic representation,
computeGraphic
will automatically be called on the item in
all the managers that include the container.
setItem
in interface IltShelfItemContainer
slotIndex
- Slot number in this container where the item will start.item
- Child item inserted in the container.slotSpan
- Positive double value representing the number of slots
over which the item will span. It can be lower than
1
and greater than 2
.IlpShelfItemPosition
,
IlpGraphView.setPosition(ilog.cpl.model.IlpRepresentationObject, ilog.cpl.graphic.IlpPosition, ilog.cpl.graphic.IlpPositionSource)
,
IltDefaultDataSource
,
IltObject.setPosition(ilog.cpl.graphic.IlpPosition)
@Deprecated public IltObject getItem(int slotIndex)
slotIndex
.
The slot might be only partially occupied by the returned item if the
slot span of the item is not an integer.getItem
in interface IltShelfItemContainer
IltDefaultDataSource
,
IlpShelfItemPosition
@Deprecated public Enumeration getItems(int slotIndex, double slotSpan)
Enumeration
of the child items contained in the
container starting at position slotIndex
and spanning over
slotSpan
. The child items returned might be only partially
in the given interval. If slotSpan
is -1.0, all the items
are returned, starting at position slotIndex
.getItems
in interface IltShelfItemContainer
IltObject
IltDefaultDataSource
,
IlpShelfItemPosition
@Deprecated public double getItemSpan(int slotIndex)
getPosition
on the card that you are querying
to retrieve the span information.slotIndex
. If no item is present in the slot,
returns the number of slots which are empty around the given index.getItemSpan
in interface IltShelfItemContainer
IlpShelfItemPosition
,
IlpGraphView.getPosition(ilog.cpl.model.IlpRepresentationObject)
,
IltDefaultDataSource
,
IltObject.getPosition()
@Deprecated public int findItem(IltObject item)
getPosition
.item
child item
is using. If the child item does not occupy any slot of the current shelf
object, -1
is returned.findItem
in interface IltShelfItemContainer
IlpShelfItemPosition
,
IlpGraphView.getPosition(ilog.cpl.model.IlpRepresentationObject)
,
IltDefaultDataSource
,
IltObject.getPosition()
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.