public class IltShelf extends IltObject implements IltShelfItemContainer, IltContainer
IltShelf
class is used to represent shelf configurations.
A shelf is made up of a given number of horizontal slots (x
slots)
and vertical slots (y
slots) forming a rectangular matrix of
variable-sized slots.
The shelf graphic representation consists of a frame divided into rectangles (one for each slot with its corresponding width and height). Each slot column is assigned a number which is displayed either below (default) or above the shelf outline. The slot columns are numbered continuously from a given initial value or according to the slot labels configured using cascading style sheets.
IltShelf
objects play the role of graphic containers for any
IltObject
; they are especially suitable for shelf items of
the following classes: IltCard
, IltEmptySlot
and IltCardCarrier
.
Modifier and Type | Class and Description |
---|---|
static class |
IltShelf.Type
This enumeration lists the types of shelves.
|
IltObject.ListPrimaryStateStyleValueProvider, IltObject.LogicalType, IltObject.TinyType
Modifier and Type | Field and Description |
---|---|
static IltAttribute |
DirectionAttribute
Attribute used to define the direction of the shelf.
|
static IlpColorKey |
FrameColor
Deprecated.
Please use CSS property
frameColor instead. |
static IltObjectInfo |
metainfo
Contains metainformation about this
IltObject class. |
static IltAttribute |
SlotSizesAttribute
Attribute that manages the number of slots and its dimensions.
|
static IltAttribute |
TypeAttribute
Attribute used to define the type of the shelf.
|
static IltAttribute |
XSlotFirstIndex
Deprecated.
Please use
IltShelf.XSlotIndexAttribute instead. |
static IltAttribute |
XSlotIndexAttribute
Aa attribute used to define the logical first index for the slots
along the
X axis of a shelf. |
static IlpStringArrayKey |
XSlotLabels
Stores the labels that shall be used as slot labels when
drawing a shelf
|
static IlpIntegerKey |
XSlotNumbersOffset
Deprecated.
Please use CSS property
XSlotNumbersOffset instead. |
static IlpBooleanKey |
XSlotNumbersOnTop
Deprecated.
Please use CSS property
XSlotNumbersOnTop instead. |
_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 |
---|
IltShelf(IlpClass ilpClass,
Object identifier)
Creates a new shelf with the given identifier.
|
IltShelf(int[] xSlotWidths,
int[] ySlotWidths,
int xSlotIndex)
This constructor creates an instance of a standard
IltShelf
with variable-width slots. |
IltShelf(int[] slotWidths,
int slotHeight,
int logicalFirstIndex)
This constructor creates an instance of a standard type
IltShelf
with variable-width slots. |
IltShelf(int sCount,
int sWidth,
int sHeight,
int index)
This constructor creates an instance of
IltShelf with fixed-width
slots, and with the Standard type. |
IltShelf(int numXSlots,
int widthXSlot,
int numYSlots,
int widthYSlot,
int xSlotIndex)
This constructor creates an instance of a standard
IltShelf
with fixed-width slots. |
IltShelf(Object identifier)
Creates a new shelf with the given identifier.
|
Modifier and Type | Method and Description |
---|---|
void |
applyTransform(IltGraphicManager manager,
IltGraphic graphic,
IlvTransformer t,
IlpPositionSource reason)
Deprecated.
|
boolean |
areSlotNumsOnTop()
Deprecated.
Please use the CSS property
XSlotNumbersOnTop instead. |
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,
IlvPoint position)
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.
|
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.
|
int |
findItem(IltObject item)
Deprecated.
Please use the
IltShelfItem.getPosition or retrieve
the shelf item position from the component view. |
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 position of the graphic representation in a given
IltGraphicManager.
|
Enumeration |
getChildren()
Deprecated.
In the future, relationships will only be defined at
the datasource level.
|
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 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 xSlotIndex,
int ySlotIndex)
Deprecated.
Containment relationships should be declared and retrieved
at the Datasource level.
|
IlpShelfItemPosition |
getItemPosition(IltObject item)
Deprecated.
Please use the
IltShelfItem.getPosition or retrieve
the shelf item position from the component view. |
IlvRect |
getItemRect(IltGraphicManager manager,
IltObject item)
Deprecated.
Adding a object to a datasource, connected to a graphic component such as
an
IlpNetwork , is enough to make its graphic representation
visible. Retrieve the bounding box of the children object from its
graphic representation. |
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 xSlotIndex,
double xSlotSpan,
int ySlotIndex,
double ySlotSpan)
Deprecated.
Containment relationships should be declared and retrieved
at the Datasource level.
|
double |
getItemSpan(int slotIndex)
Deprecated.
Please use the
IltShelfItem.getPosition or retrieve
the shelf item position from the component view. |
int |
getLogicalFirstIndex()
Deprecated.
Use the method
getAttributeValue to retrieve the
XSlotIndexAttribute attribute instead. |
ilog.util.internal.IlAVector |
getMappedForUserList() |
IltStateHolder |
getOverviewObject()
Deprecated.
Containment relationships should be declared at the
Datasource level.
|
int |
getSizeOtherDimension()
Returns the size of the other dimension for all the slots.
|
int |
getSlotCount()
Accesses the total number of slots in the container.
|
int |
getSlotNumSpace()
Deprecated.
Please use the CSS property
XSlotNumbersOffset instead. |
int[] |
getSlotSizes()
Returns the slot sizes.
|
double |
getSlotSpanX(int xIndex,
int yIndex)
Deprecated.
Containment relationships should be declared and retrieved
at the Datasource level.
|
double |
getSlotSpanY(int xIndex,
int yIndex)
Deprecated.
Containment relationships should be declared and retrieved
at the Datasource level.
|
IltStatePropagator |
getStatePropagator()
Deprecated.
State propagation at the graphic level is not supported
in the Network Component.
|
IlvPoint |
getTopLeftPoint(IltGraphicManager manager)
Deprecated.
Please use
getPosition instead. |
protected IlvPoint |
getTopLeftPoint(IltGraphicManager manager,
IltGraphic graphic)
Returns the shape graphic setting.
|
IltShelf.Type |
getType()
Returns the type of the shelf.
|
int[] |
getXSlotSizes()
Accesses the sizes of the slots along the
x axis. |
int[] |
getYSlotSizes()
Accesses the sizes of the slots along the
y axis. |
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.
|
protected void |
initializeShelf(int[] xSlotWidths,
int[] ySlotWidths,
int xSlotIndex)
This method should be only called by the constructors.
|
protected void |
initializeShelf(int countXSlot,
int slotWidth,
int countYSlot,
int slotHeight,
int xSlotIndex)
This method should be only called by the constructors.
|
boolean |
isValidPosition(Object position)
Determines whether the argument is a valid position/shape for this type
of object.
|
protected void |
recreateChildren(ilog.tgo.model.internal.IltSlotArray sArray,
ilog.tgo.model.internal.IltSlotSizes sSizes) |
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 . |
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 |
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 position of the graphic representation in a given
IltGraphicManager.
|
void |
setDetailObjects(IltChildrenModel details)
Deprecated.
Containment relationships should be declared at the
Datasource level.
|
void |
setDirection(int direction)
Deprecated.
Please use the method
setAttributeValue to
change the IltShelf.DirectionAttribute
instead. The direction has changed from
IlvDirection to IlpDirection . |
void |
setDirection(int direction,
int itemsDirection)
Deprecated.
Whenever the direction of a shelf changes, all its
children directions change accordingly. Update each
child direction individually instead, by using
the
setAttributeValue method to change the
IltShelf.DirectionAttribute of each
child object. The direction has changed from
IlvDirection to IlpDirection . |
void |
setItem(int xSlotIndex,
double xSlotSpan,
int ySlotIndex,
double ySlotSpan,
IltObject item)
Deprecated.
Containment relationships should be declared at the
Datasource level. Please insert your shelf item in the
datasource, setting it as child of this shelf. It will also
be necessary to define its position within the shelf. You
can do this, by setting the shelf item position attribute
to a
IlpShelfItemPosition |
void |
setItem(int slotIndex,
IltObject item)
Deprecated.
Containment relationships should be declared at the
Datasource level. Please insert your shelf item in the
datasource, setting it as child of this shelf. It will also
be necessary to define its position within the shelf. You
can do this, by setting the shelf item position attribute
to a
IlpShelfItemPosition |
void |
setItem(int slotIndex,
IltObject item,
double slotSpan)
Deprecated.
Containment relationships should be declared at the
Datasource level. Please insert your shelf item in the
datasource, setting it as child of this shelf. It will also
be necessary to define its position within the shelf. You
can do this, by setting the shelf item position attribute
to a
IlpShelfItemPosition |
void |
setItem(int xSlotIndex,
int ySlotIndex,
IltObject item)
Deprecated.
Containment relationships should be declared at the
Datasource level. Please insert your shelf item in the
datasource, setting it as child of this shelf. It will also
be necessary to define its position within the shelf. You
can do this, by setting the shelf item position attribute
to a
IlpShelfItemPosition |
void |
setLogicalFirstIndex(int logicalFirstIndex)
Deprecated.
Use the method
setAttributeValue to set the
XSlotIndexAttribute attribute instead. |
void |
setOverviewObject(IltStateHolder overview)
Deprecated.
Containment relationships should be declared at the
Datasource level. In case of shelves, the overview object
can not be changed, as it is the shelf instance itself.
|
void |
setSizeOtherDimension(int sizeOtherDimension)
Changes the size of the other dimension for all the slots.
|
void |
setSlotNumsOnTop(boolean slotNumsOnTop)
Deprecated.
Please use the CSS property
XSlotNumbersOnTop instead. |
void |
setSlotNumSpace(int slotNumSpace)
Deprecated.
Please use the CSS property
XSlotNumbersOffset instead. |
void |
setSlotSizes(int[] slotSizes)
Changes the number and size of slots.
|
void |
setSlotSizes(int[] xSlotWidths,
int[] ySlotWidths)
Changes the number and size of the slots in both
x and
y dimensions. |
void |
setSlotSizes(int slotCount,
int slotSize)
Changes the number and size of slots.
|
void |
setSlotSizes(int numXSlots,
int widthXSlot,
int numYSlots,
int widthYSlot)
Changes the number of slots and their size in both
x and
y dimensions. |
void |
setStatePropagator(IltStatePropagator propagator)
Deprecated.
State propagation at the graphic level is not supported
in the Network Component.
|
void |
setTopLeftPoint(IltGraphicManager manager,
IltGraphic graphic,
IlvPoint position,
IlpPositionSource reason)
Changes the shape graphic setting.
|
void |
setTopLeftPoint(IltGraphicManager manager,
IlvPoint topLeftPoint)
Deprecated.
Please use
setPosition instead. |
void |
setTopLeftPoint(IltGraphicManager manager,
IlvPoint topLeftPoint,
IlpPositionSource reason)
Deprecated.
Please use
setPosition instead. |
void |
setTopLeftPointInManager(IltGraphicManager manager,
IltGraphic graphic,
IlvPoint position,
IlpPositionSource reason)
Changes the position of the graphic representation in a given
IltGraphicManager.
|
void |
setType(IltShelf.Type type)
Changes the type of the shelf.
|
void |
setXSlotSizes(int numXSlots,
int widthXSlot)
Changes the number of slots and their size in the
x
dimension. |
void |
setYSlotSizes(int numYSlots,
int widthYSlot)
Changes the number of slots and their size in the
y
dimension. |
Object |
transformPosition(IltGraphicManager manager,
Object position)
Applies the manager transformer to the position parameter.
|
void |
updateFrom(IltObject other)
Updates the local cache of attributes stored in getObjectAttribute().
|
void |
updateShapeGraphicSettingInManager(IltGraphicManager manager,
IltGraphic graphic,
Object newShape,
IlpPositionSource reason)
If the graphic representation is visible, updates the shape graphic
setting in manager coordinates.
|
protected void |
updateSlotSizes(int[] xSlotWidths,
int[] ySlotWidths) |
__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, 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, 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, usingDefaultShape
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 IlpColorKey FrameColor
frameColor
instead.IltObjectCustomization.getFrameColor()
@Deprecated public static IlpBooleanKey XSlotNumbersOnTop
XSlotNumbersOnTop
instead.x
axis.
The slot numbers may be positioned at the top or at the bottom of a shelf.
IltObjectCustomization.isXSlotNumbersOnTop()
@Deprecated public static IlpIntegerKey XSlotNumbersOffset
XSlotNumbersOffset
instead.X
axis.
It defines the distance between the slot numbering and the shelf.
IltObjectCustomization.getXSlotNumbersOffset()
public static IlpStringArrayKey XSlotLabels
public static IltAttribute TypeAttribute
Attribute name: type
.
Value type: IltShelf.Type
.
public static IltAttribute SlotSizesAttribute
Attribute name: slotSizes
.
Value type: IlpSlotSizes
.
IlpSlotSizes
public static IltAttribute DirectionAttribute
Attribute name: direction
.
Value type: IlpDirection
.
IlpDirection
public static IltAttribute XSlotIndexAttribute
X
axis of a shelf.
The logical first index is the initial number displayed to count the
slots, by default its value is 0
(zero).
Attribute name: xslotindex
.
Value type: Integer
.
@Deprecated public static IltAttribute XSlotFirstIndex
IltShelf.XSlotIndexAttribute
instead.X
axis of a shelf.
Its value is an instance of Integer
.
Logical first index is the initial number displayed to count the
slots, by default its value is 0
(zero).
public IltShelf(Object identifier)
The shelf properties must be set using the accessors.
identifier
- the identifier of this new instancepublic IltShelf(IlpClass ilpClass, Object identifier)
The shelf properties must be set using the accessors.
ilpClass
- the business class of this new instance. It must be a
subclass of IltShelf
identifier
- the identifier of this new instancepublic IltShelf(int numXSlots, int widthXSlot, int numYSlots, int widthYSlot, int xSlotIndex)
IltShelf
with fixed-width slots.
Note: The type can be modified with setType
.
numXSlots
- The number of slots along the x
axis.widthXSlot
- The width of each slot on the x
axis.numYSlots
- The number of slots along the y
axis.widthYSlot
- The width of each slot on the y
axis.xSlotIndex
- Specifies the value of the first slot number
displayed below or above the shelf frame.
Numbering is sequential.public IltShelf(int[] xSlotWidths, int[] ySlotWidths, int xSlotIndex)
IltShelf
with variable-width slots.
Note: The type can be modified with setType
.
xSlotWidths
- An array of integers, each one corresponding to the width
of a slot along the x
axis. The
width of a slot can be 0
.ySlotWidths
- An array of integers, each one corresponding to the width
of a slot along the y
axis. The
width of a slot can be 0
.xSlotIndex
- Specifies the value of the first slot number
displayed below or above the shelf frame.
Numbering is sequential. Slots with a width of 0
are ignored, which may lead to non-sequential numbering.public IltShelf(int sCount, int sWidth, int sHeight, int index)
IltShelf
with fixed-width
slots, and with the Standard type.
Note: The type can be modified with setType
.
sCount
- Number of slots in the shelfsWidth
- Width of the slots in the shelfsHeight
- Height of the slots in the shelf. This will
also be the height of the shelf.index
- Specifies the value of the first slot number
to be displayed either
below or above the shelf frame. Numbering is
sequential.public IltShelf(int[] slotWidths, int slotHeight, int logicalFirstIndex)
IltShelf
with variable-width slots.
Note: The type can be modified with setType
.
slotWidths
- Array of integers, each one corresponding to the width of
a slot. The width of a slot can be 0.slotHeight
- Height of the slots in the shelf. This will
also be the height of the shelf.logicalFirstIndex
- Specifies the value of the first slot number
to be displayed
below or above the shelf frame. Numbering is
sequential. Slots with a width of 0 are
ignored, which may lead to non-sequential
numbering.public static IltObjectInfo GetIlpClass()
@Deprecated public static IltLegend GetClassLegend()
protected void initializeObject(IltObjectState state, String name)
initializeObject
in class IltObject
IltObject.initializeObject(ilog.tgo.model.IltObjectState, java.lang.String)
protected void initializeShelf(int countXSlot, int slotWidth, int countYSlot, int slotHeight, int xSlotIndex)
protected void initializeShelf(int[] xSlotWidths, int[] ySlotWidths, int xSlotIndex)
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, ilog.tgo.model.internal.IltSlotSizes sSizes)
public IltShelf.Type getType()
public void setType(IltShelf.Type type)
@Deprecated public void setSlotNumsOnTop(boolean slotNumsOnTop)
XSlotNumbersOnTop
instead.x
axis are displayed
above or below the shelf outline.
This method sets the value in the object style in the default application context only.
slotNumsOnTop
- true
means that the numbers
display above the shelf, false
that they display below.@Deprecated public boolean areSlotNumsOnTop()
XSlotNumbersOnTop
instead.true
if the slot logical numbers for the x
axis
display above the shelf outline.
This method retrieves the value in the object style in the default application context only.
@Deprecated public void setSlotNumSpace(int slotNumSpace)
XSlotNumbersOffset
instead.This method sets the value in the object styling the default application context only.
slotNumSpace
- The vertical space in pixels@Deprecated public int getSlotNumSpace()
XSlotNumbersOffset
instead.This method retrieves the value in the object style in the default application context only.
@Deprecated public void setLogicalFirstIndex(int logicalFirstIndex)
setAttributeValue
to set the
XSlotIndexAttribute
attribute instead.logicalFirstIndex
- Specifies the value of the first slot number for
the numbers that will be displayed below or above
the shelf frame. Numbering is sequential.XSlotIndexAttribute
@Deprecated public int getLogicalFirstIndex()
getAttributeValue
to retrieve the
XSlotIndexAttribute
attribute instead.XSlotIndexAttribute
public void setSlotSizes(int[] xSlotWidths, int[] ySlotWidths)
x
and
y
dimensions.
Shelf items are resized accordingly. If there are less slots than before, the excess items are removed.
xSlotWidths
- An array of integers, each one corresponding to the size of a slot
along the x
axis. The size of a slot can
be 0
.ySlotWidths
- An array of integers, each one corresponding to the size of a slot
along the y
axis. The size of a slot can
be 0
.protected void updateSlotSizes(int[] xSlotWidths, int[] ySlotWidths)
public void setSlotSizes(int numXSlots, int widthXSlot, int numYSlots, int widthYSlot)
x
and
y
dimensions.
The shelf items are resized accordingly. If the number of slots decreases, the excess items are removed.
numXSlots
- Number of slots along the x
axiswidthXSlot
- Size of each slot along the x
axisnumYSlots
- Number of slots along the y
axiswidthYSlot
- Size of each slot along the y
axispublic void setXSlotSizes(int numXSlots, int widthXSlot)
x
dimension.
The shelf items are resized accordingly. If the number of slots decreases, the excess items are removed.
numXSlots
- Number of slots along the x
axiswidthXSlot
- Size of each slot along the x
axispublic void setYSlotSizes(int numYSlots, int widthYSlot)
y
dimension.
The shelf items are resized accordingly. If the number of slots decreases, the excess items are removed.
numYSlots
- Number of slots along the y
axiswidthYSlot
- Size of each slot along the y
axispublic int[] getXSlotSizes()
x
axis.public int[] getYSlotSizes()
y
axis.public Object transformPosition(IltGraphicManager manager, Object position)
computeGraphic (mgr, position)
transformPosition
in class IltObject
public boolean isValidPosition(Object position)
IltObject
This function overridden in subclasses. Accepted positions are:
IlvPoint
for IltNetworkElement
,
IltOffPageConnector
, IltShelf
,
IlvRect
for IltRectGroup
,
IltShelfItem
,
IlpPolyline
for IltAbstractLink
,
IltLinearGroup
,
IlpPolygon
for IltPolyGroup
.
isValidPosition
in class IltObject
public ilog.tgo.graphic.internal.IltGraphicUpdate createPositionUpdate(Object position, Object positionInManager)
null
, the position/shape set will be
the default value.createPositionUpdate
in class IltObject
position
- the shape in stationary coordinatespositionInManager
- the shape in manager coordinates (takes into
account the logical zoom transformer)public void updateShapeGraphicSettingInManager(IltGraphicManager manager, IltGraphic graphic, Object newShape, IlpPositionSource reason)
updateShapeGraphicSettingInManager
in class IltObject
newShape
- the new shape in stationary coordinates; null
means the current value of the shape graphic settingreason
- the reason for the shape change, or null
if
unknownprotected IlvPoint getCenterPoint(IltGraphicManager manager, IltGraphic graphic)
getCenterPoint
in class IltObject
public void setCenterPoint(IltGraphicManager manager, IltGraphic graphic, IlvPoint position, IlpPositionSource reason)
setCenterPoint
in class IltObject
public IlvRect getBaseRectangle(IltGraphicManager manager)
getBaseRectangle
in class IltObject
null
if the base has no extent at allpublic void setBaseRectangle(IltGraphicManager manager, IlvRect newBaseRectangle)
setBaseRectangle
in class IltObject
public Object defaultShape()
defaultShape
in class IltObject
@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, IlvPoint position)
IlpNetwork
, is enough to make its graphic representation
visible.manager
- manager in which this shelf will be represented graphicallyposition
- coordinates of the top left corner of the shelf in the given managerpublic 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 initializeCreatedGraphic(IltGraphicManager manager, IltGraphic graphic)
IltObject
initializeCreatedGraphic
in class IltObject
@Deprecated public void applyTransform(IltGraphicManager manager, IltGraphic graphic, IlvTransformer t, IlpPositionSource reason)
IltObject
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.
applyTransform
in class IltObject
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 unknownIltObject.applyTransform(ilog.tgo.graphic.IltGraphicManager, ilog.views.IlvTransformer)
,
IltGraphicManager.getZoomTransformer()
public ilog.tgo.graphic.internal.base.IltBaseElement createBase(IltcGraphicElementAggregate root)
createBase
in class IltObject
IltCompositeGraphic.createBase(IltcGraphicElementAggregate, IltObject)
,
IltObject.createTinyBase(IltcGraphicElementAggregate)
@Deprecated public IlvPoint getTopLeftPoint(IltGraphicManager manager)
getPosition
instead.protected IlvPoint getTopLeftPoint(IltGraphicManager manager, IltGraphic graphic)
@Deprecated public void setTopLeftPoint(IltGraphicManager manager, IlvPoint topLeftPoint)
setPosition
instead.manager
- a specific manager into which this shelf has already been
inserted.topLeftPoint
- the new position of the top left corner of the shelf.
The size of the shelf is determined by the slot sizes.@Deprecated public void setTopLeftPoint(IltGraphicManager manager, IlvPoint topLeftPoint, IlpPositionSource reason)
setPosition
instead.manager
- a specific manager into which this shelf has already been
inserted.topLeftPoint
- the new position of the top left corner of the shelf.
The size of the shelf is determined by the slot sizes.reason
- the reason for the position change, or null
if unknownpublic void setTopLeftPoint(IltGraphicManager manager, IltGraphic graphic, IlvPoint position, IlpPositionSource reason)
public void setTopLeftPointInManager(IltGraphicManager manager, IltGraphic graphic, IlvPoint position, IlpPositionSource reason)
@Deprecated public IltStateHolder getOverviewObject()
IltShelf
.getOverviewObject
in interface IltContainer
IltDefaultDataSource
@Deprecated public void setOverviewObject(IltStateHolder overview)
IltShelf
instances.setOverviewObject
in interface IltContainer
IltDefaultDataSource
@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 xSlotIndex, int ySlotIndex, IltObject item)
IlpShelfItemPosition
If the container already has a graphic representation,
the method computeGraphic
will be automatically invoked
on every manager that contains it.
The container position is based on a two-dimensional matrix where each child is placed according to an origin point (x and y coordinates) plus a two-dimensional span (x span and y span).
This method considers a span equal to 1.0
, that is,
no span at all.
xSlotIndex
- The slot index for the x
coordinateySlotIndex
- The slot index for the y
coordinateitem
- The child object to be inserted in the containerIltDefaultDataSource
,
IlpShelfItemPosition
@Deprecated public void setItem(int xSlotIndex, double xSlotSpan, int ySlotIndex, double ySlotSpan, IltObject item)
IlpShelfItemPosition
The child object will start at xSlotIndex
and
ySlotIndex
, expanding over other slots according to
xSlotSpan
and ySlotSpan
attributes.
The container position is based on a two-dimensional matrix where each child is placed according to an origin point (x and y coordinates) plus a two-dimensional span (x span and y span).
The span attribute is a positive double representing a fraction of a slot;
1.0
corresponds to one slot, 1.5
corresponds to
one slot plus half of the next slot, and so on and so forth.
Any child already located in the position defined by the new child will
be removed from the container.
If the container already has a graphic representation,
the method computeGraphic
will be automatically invoked
on every manager that contains it.
xSlotIndex
- The slot index for the x
coordinatexSlotSpan
- The slot spanning for the x
coordinateySlotIndex
- The slot index for the y
coordinateySlotSpan
- The slot spanning for the y
coordinateitem
- The child object to be inserted in the containerIltDefaultDataSource
,
IlpShelfItemPosition
@Deprecated public boolean removeItem(IltObject item)
removeItem
in interface IltShelfItemContainer
true
if item
was found and removed,
false
if item
does not belong to the containerIltDefaultDataSource
@Deprecated public void removeAllItems()
removeAllItems
in interface IltShelfItemContainer
IltDefaultDataSource
@Deprecated public IltObject getItem(int xSlotIndex, int ySlotIndex)
xSlotIndex
and ySlotIndex
.
The slot might be partially occupied by the returned item (if the corresponding slot span is not an integer).
xSlotIndex
- The slot index for the x
coordinateySlotIndex
- The slot index for the y
coordinateIltDefaultDataSource
,
IlpShelfItemPosition
@Deprecated public Enumeration getItems()
getItems
in interface IltShelfItemContainer
Enumeration
of IltObject
containing all child itemsIltDefaultDataSource
@Deprecated public Enumeration getItems(int xSlotIndex, double xSlotSpan, int ySlotIndex, double ySlotSpan)
Enumeration
of the child items
(IltObject
instances) in the container which are fully
or partially covered by the area defined by
xSlotIndex
, ySlotIndex
,
xSlotSpan
and ySlotSpan
.xSlotIndex
- The slot index for the x
coordinatexSlotSpan
- Positive non-zero double representing the slot
spanning for the x
coordinateySlotIndex
- The slot index for the y
coordinateySlotSpan
- Positive non-zero double representing the slot
spanning for the y
coordinateIltDefaultDataSource
@Deprecated public double getSlotSpanX(int xIndex, int yIndex)
x
axis across which the children in the given slot span.
If no item is present in the slot, the method returns the number of
contiguous empty slots on either side (x
axis) of the given slot.
xIndex
- The x
slot coordinateyIndex
- The y
slot coordinatex
axisIltDefaultDataSource
,
IlpShelfItemPosition
@Deprecated public double getSlotSpanY(int xIndex, int yIndex)
y
axis across which the children in the given slot span.
If no item is present in the slot, the method returns the number of
contiguous empty slots on either side (y
axis) of the given slot.
xIndex
- The x
slot coordinateyIndex
- The y
slot coordinatey
axisIltDefaultDataSource
,
IlpShelfItemPosition
@Deprecated public IlpShelfItemPosition getItemPosition(IltObject item)
IltShelfItem.getPosition
or retrieve
the shelf item position from the component view.x
and y
slot positioning.getItemPosition
in interface IltShelfItemContainer
item
- The child object which slot position to retrieveIlpShelfItemPosition
object containing
positioning information, or null
if
item
does not belong to the containerIlpShelfItemPosition
,
IltObject.getPosition()
,
IlpGraphView.getPosition(ilog.cpl.model.IlpRepresentationObject)
public int getSlotCount()
getSlotCount
in interface IltShelfItemContainer
x
and
y
dimensions@Deprecated public IlvRect getItemRect(IltGraphicManager manager, IltObject item)
IlpNetwork
, is enough to make its graphic representation
visible. Retrieve the bounding box of the children object from its
graphic representation.getItemRect
in interface IltShelfItemContainer
manager
- The container's graphic manageritem
- The child object@Deprecated public void setDirection(int direction)
setAttributeValue
to
change the IltShelf.DirectionAttribute
instead. The direction has changed from
IlvDirection
to IlpDirection
.Direction
style value for the shelf.
The directions of all child objects are also 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 by this method; all style values are computed and set based on the default context only.
setDirection
in interface IltShelfItemContainer
direction
- Either IlvDirection.Top
,
IlvDirection.Bottom
,
IlvDirection.Left
, or
IlvDirection.Right
DirectionAttribute
@Deprecated public void setDirection(int direction, int itemsDirection)
setAttributeValue
method to change the
IltShelf.DirectionAttribute
of each
child object. The direction has changed from
IlvDirection
to IlpDirection
.Direction
style value for the
shelf.
All child objects are also 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 by this method; all style values are computed and set based on the default context only.
setDirection
in interface IltShelfItemContainer
direction
- Either IlvDirection.Top
,
IlvDirection.Bottom
,
IlvDirection.Left
, or
IlvDirection.Right
itemsDirection
- Either IlvDirection.Top
,
CODE>IlvDirection.Bottom,
IlvDirection.Left
, or
IlvDirection.Right
DirectionAttribute
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 IltObject
attribute
- The attribute which value is being set.value
- The new value of the attribute, or
VALUE_NOT_SET
to remove the value
of the attribute.IllegalArgumentException
- if the attribute cannot have
its value modified.public ilog.util.internal.IlAVector getMappedForUserList()
getMappedForUserList
in class IltObject
public void setSlotSizes(int[] slotSizes)
The shelf items are resized accordingly. If slotSizes
specifies less slots than before, the excess items are removed.
slotSizes
- Array of integers, each one corresponding to the size of a
slot. The size of a slot can be 0.public void setSlotSizes(int slotCount, int slotSize)
The shelf items are resized accordingly. If slotSizes
specifies less slots than before, the excess items are removed.
slotCount
- Number of slots in the shelfslotSize
- Width of the slots in the shelfpublic int[] getSlotSizes()
public void setSizeOtherDimension(int sizeOtherDimension)
public int getSizeOtherDimension()
@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 display the container.
setItem
in interface IltShelfItemContainer
slotIndex
- The slot number of this container where the item will be set.item
- The item inserted in the container.IltDefaultDataSource
,
IlpShelfItemPosition
@Deprecated public void setItem(int slotIndex, IltObject item, double slotSpan)
IlpShelfItemPosition
slotIndex
and spanning over slotSpan
slots. The child
items previously occupying these slots
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 displaying the container.
setItem
in interface IltShelfItemContainer
slotIndex
- Slot number of 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.@Deprecated public IltObject getItem(int slotIndex)
slotIndex
.
The returned item might only partially occupy the slot 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 located in the
container, starting at position slotIndex
and spanning over
slotSpan
. The returned child items might only partially
occupy the given interval. If slotSpan
equals -1.0
,
all the items are returned, starting at position slotIndex
.getItems
in interface IltShelfItemContainer
IltObject
IltDefaultDataSource
@Deprecated public double getItemSpan(int slotIndex)
IltShelfItem.getPosition
or retrieve
the shelf item position from the component view.slotIndex
. If no item is present in the slot,
the method returns the number of empty slots surrounding the given index.getItemSpan
in interface IltShelfItemContainer
IltDefaultDataSource
,
IlpShelfItemPosition
,
IltObject.getPosition()
,
IlpGraphView.getPosition(ilog.cpl.model.IlpRepresentationObject)
@Deprecated public int findItem(IltObject item)
IltShelfItem.getPosition
or retrieve
the shelf item position from the component view.item
child item.
If the child item does not occupy any slot in the current shelf
object, the method returns -1
.findItem
in interface IltShelfItemContainer
IlpShelfItemPosition
,
IltObject.getPosition()
,
IlpGraphView.getPosition(ilog.cpl.model.IlpRepresentationObject)
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.