|
||||||||||
| 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.IltAbstractLink
ilog.tgo.model.IltLinkBundle
public class IltLinkBundle
An IltLinkBundle is a container which can display at any time
either an overview object (a link) or a set of detail objects
(links having the same start and end nodes as the overview link).
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class ilog.tgo.model.IltObject |
|---|
IltObject.ListPrimaryStateStyleValueProvider, IltObject.LogicalType, IltObject.TinyType |
| Field Summary | |
|---|---|
static IltObjectInfo |
metainfo
Contains metainformation about this IltObject class. |
| Fields inherited from class ilog.tgo.model.IltAbstractLink |
|---|
DefaultLinkDistance, FromPort, FromPortAttribute, InnerBackgroundColor, InnerBorderWidth, InnerCenterWidth, InnerForegroundColor, InnerLineStyle, propSupport, ToPort, ToPortAttribute |
| Fields inherited from interface ilog.cpl.model.IlpAttributeValueHolder |
|---|
VALUE_NOT_SET |
| Constructor Summary | |
|---|---|
IltLinkBundle()
Creates a new container. |
|
IltLinkBundle(IlpClass ilpClass,
Object identifier)
Creates a new container with the given class and identifier. |
|
IltLinkBundle(IltAbstractLink overview,
Enumeration detail)
Deprecated. Please use the constructor that takes an object identifier and define the link bundle relationships in the datasource. |
|
IltLinkBundle(IltAbstractLink overview,
IltChildrenModel detail)
Deprecated. Please use the constructor that takes an object identifier and define the link bundle relationships in the datasource. |
|
IltLinkBundle(IltAbstractLink overview,
IltStateHolder[] detail)
Deprecated. Please use the constructor that takes an object identifier and define the link bundle relationships in the datasource. |
|
IltLinkBundle(Object identifier)
Creates a new container with the given identifier. |
|
| Method Summary | |
|---|---|
void |
addLink(IltAbstractLink link)
Deprecated. Please use the datasource to define the containment relationship. |
IltObject |
cloneForRendering(boolean displayChildren)
Creates a clone of this object for IltGraphicRenderer purposes only. |
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. |
IlpAttributeGroup |
getAttributeGroup()
Returns the model that defines which attributes are allowed in this instance. |
Object |
getAttributeValue(IlpAttribute attribute)
Retrieves the value of an attribute of 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. Please use datasources to store the containment relationship of your link bundle objects. |
IltDetailExpansionRenderer |
getDetailRenderer()
Deprecated. Link bundle rendering is automatically accomplished by the Network component. Only in-place expansion is currently supported. |
static IltObjectInfo |
GetIlpClass()
Returns the IlpClass corresponding to this Java class. |
ilog.tgo.model.internal.IltLinkBundleModifier |
getLinkBundleModifier()
|
float |
getLinkDistance()
Deprecated. Please use CSS property linkDistance instead. |
float |
getLinkDistance(IltGraphicManager manager)
Deprecated. Please use CSS property linkDistance instead. |
IltStateHolder |
getOverviewObject()
Deprecated. This method shall not be used when the object is in a datasource. |
IltStatePropagator |
getStatePropagator()
Deprecated. State propagation at the graphic level is not supported in the Network Component. |
float |
getWidth(IltGraphicManager manager,
IltGraphic graphic)
Returns the width of the graphic representation. |
boolean |
hasAttributeValue(IlpAttribute attribute)
Returns true if the requested attribute is part of the
attribute group of this instance and if a value has been set for this
attribute. |
void |
initializeCreatedGraphic(IltGraphicManager manager,
IltGraphic graphic)
This method must be called just after preCreateGraphic to initialize any needed property or graphic setting. |
protected void |
initializeLinkBundle(IltAbstractLink overview,
IltChildrenModel detail)
|
boolean |
isExpanded(IltGraphicManager manager)
Deprecated. Please use the Network component and its services to manage subnetworks and link bundles instead. |
boolean |
isOutsideExpanded()
Deprecated. Outside expandable containers are not supported by the Network component. |
void |
removeGraphic(IltGraphicManager manager)
Deprecated. Removing an object from the datasource containing it is enough to make its graphic representation disappear. |
void |
removeLink(IltAbstractLink link)
Deprecated. Please use the datasource to define the containment relationship. |
void |
setAttributeValue(IlpAttribute attribute,
Object value)
Sets the value of an attribute of this object. |
void |
setDetailObjects(IltChildrenModel details)
Deprecated. Containment relationships should be stored in a Datasource. Please use the DataSource API to declare the structure of your objects. |
void |
setDetailRenderer(IltDetailExpansionRenderer renderer)
Deprecated. Link bundle rendering is automatically accomplished by the Network component. Only in-place expansion is currently supported. |
void |
setExpanded(IltGraphicManager manager,
boolean expansionVisible)
Deprecated. Please use the Network component and its services to manage subnetworks and link bundles instead. |
void |
setFrom(IltGraphicManager manager,
IltObject from)
Sets the object that is to use as the first extremity of the link in the given manager. |
void |
setLinkDistance(float d)
Deprecated. Please use CSS property linkDistance instead. |
void |
setLinkDistance(IltGraphicManager manager,
float d)
Deprecated. Please use CSS property linkDistance instead. |
void |
setLinkLayoutProxyPresent(IltGraphicManager manager,
boolean layoutable)
Sets the layoutability of the link in the given manager. |
void |
setOutsideExpanded(boolean expansionVisible)
Deprecated. Outside expandable containers are not supported by the Network component. |
void |
setOverviewObject(IltAbstractLink overview)
Deprecated. This method shall not be used when the object is in a datasource. |
void |
setOverviewObject(IltStateHolder overview)
Sets or replaces the overview object. |
void |
setShape(IltGraphicManager manager,
IltGraphic graphic,
IlpPolyline shape,
IlpPositionSource reason)
Changes the shape graphic setting. |
void |
setShapeInManager(IltGraphicManager manager,
IltGraphic graphic,
IlpPolyline shape,
IlpPositionSource reason,
boolean assumeVisible)
Changes the shape of the link in the given manager, using the provided composite graphic. |
void |
setStatePropagator(IltStatePropagator propagator)
Deprecated. State propagation at the graphic level is not supported in the Network Component. |
void |
setTo(IltGraphicManager manager,
IltObject to)
Sets the object that is to use as the second extremity of the link in the given manager. |
| Methods inherited from class ilog.cpl.model.IlpDefaultObject |
|---|
addAttributeValueListener, fireEvent, getAttributeValue, getAttributeValueByName, getIdentifier, getIlpClass, getLocalAttributeValues, getObjectSupport, removeAttributeValueListener, setAttributeValue, setAttributeValueByName, setLocalAttributeValues, setObjectSupport |
| 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 |
| Methods inherited from interface ilog.tgo.model.IltContainer |
|---|
setObjectState |
| Methods inherited from interface ilog.tgo.model.IltStateHolder |
|---|
addStateChangedListener, getObjectState, removeStateChangedListener |
| 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.
| Constructor Detail |
|---|
public IltLinkBundle()
The set of detail objects must be specified afterwards. The overview object will be a link.
public IltLinkBundle(Object identifier)
The set of detail objects must be specified afterwards. The overview object will be a link.
identifier - the identifier of this new instance
public IltLinkBundle(IlpClass ilpClass,
Object identifier)
The set of detail objects must be specified afterwards. The overview object will be a link.
ilpClass - the business class of this new instance. It must be a
subclass of IltLinkBundleidentifier - the identifier of this new instance
public IltLinkBundle(IltAbstractLink overview,
IltChildrenModel detail)
An ID is automatically generated using IlpIDGenerator.GetID().
IltDefaultDataSource,
IltDefaultDataSource.setParent(java.lang.Object, java.lang.Object),
IltDefaultDataSource.setChildren(java.lang.Object, java.util.List)
public IltLinkBundle(IltAbstractLink overview,
Enumeration detail)
An ID is automatically generated using IlpIDGenerator.GetID().
overview - link that represents this object in its collapsed representationdetail - an enumeration of IltAbstractLinkIltDefaultDataSource,
IltDefaultDataSource.setParent(java.lang.Object, java.lang.Object),
IltDefaultDataSource.setChildren(java.lang.Object, java.util.List)
public IltLinkBundle(IltAbstractLink overview,
IltStateHolder[] detail)
An ID is automatically generated using IlpIDGenerator.GetID().
overview - link that represents this object in its collapsed representationdetail - an array of IltAbstractLinkIltDefaultDataSource,
IltDefaultDataSource.setParent(java.lang.Object, java.lang.Object),
IltDefaultDataSource.setChildren(java.lang.Object, java.util.List)| Method Detail |
|---|
public static IltObjectInfo GetIlpClass()
public static IltLegend GetClassLegend()
public IltChildrenModel getDetailObjects()
getDetailObjects in interface IltContainerIltDefaultDataSource,
IlpDataSource.getContainerInterface(java.lang.Object),
IlpContainerpublic IltStatePropagator getStatePropagator()
getStatePropagator in interface IltContainerpublic boolean isExpanded(IltGraphicManager manager)
IlpGraphView.isExpanded(ilog.cpl.model.IlpRepresentationObject)
public void setExpanded(IltGraphicManager manager,
boolean expansionVisible)
Note that this method is not supposed to be used when this
IltLinkBundle is in a DataSource.
setExpanded in interface ilog.tgo.model.internal.IltExpandableContainerIlpGraphView.expandObject(ilog.cpl.model.IlpRepresentationObject),
IlpGraphView.collapseObject(ilog.cpl.model.IlpRepresentationObject)
protected void initializeLinkBundle(IltAbstractLink overview,
IltChildrenModel detail)
public IltStateHolder getOverviewObject()
getOverviewObject in interface IltContainerIltAbstractLinkpublic void setOverviewObject(IltAbstractLink overview)
public void setOverviewObject(IltStateHolder overview)
IltContainer
setOverviewObject in interface IltContainerpublic void setDetailObjects(IltChildrenModel details)
Note that the set of detail objects can change dynamically, see
class IltChildrenModelListener.
setDetailObjects in interface IltContainerIltDefaultDataSource,
IltDefaultDataSource.setParent(java.lang.Object, java.lang.Object),
IltDefaultDataSource.setChildren(java.lang.Object, java.util.List)public void addLink(IltAbstractLink link)
Note:This function can only be called when the children model is the default one and has not been replaced.
IltDefaultDataSource,
IltDefaultDataSource.setParent(java.lang.Object, java.lang.Object),
IltDefaultDataSource.setChildren(java.lang.Object, java.util.List)public void removeLink(IltAbstractLink link)
Note:This function can only be called when the children model is the default one and has not been replaced.
IltDefaultDataSource,
IltDefaultDataSource.setParent(java.lang.Object, java.lang.Object),
IltDefaultDataSource.setChildren(java.lang.Object, java.util.List)public final ilog.tgo.model.internal.IltLinkBundleModifier getLinkBundleModifier()
public void setStatePropagator(IltStatePropagator propagator)
setStatePropagator in interface IltContainerpublic ilog.tgo.graphic.internal.base.IltBaseElement createBase(IltcGraphicElementAggregate root)
IltObject
createBase in class IltObjectIltCompositeGraphic.createBase(IltcGraphicElementAggregate, IltObject),
IltObject.createTinyBase(IltcGraphicElementAggregate)
public void initializeCreatedGraphic(IltGraphicManager manager,
IltGraphic graphic)
IltObject
initializeCreatedGraphic in class IltObjectpublic void createGraphic(IltGraphicManager manager)
IlpNetwork, is enough to make its graphic representation
visible.
Note that this method is not supposed to be used when this
IltLinkBundle is in a DataSource.
createGraphic in class IltObject
public void setShape(IltGraphicManager manager,
IltGraphic graphic,
IlpPolyline shape,
IlpPositionSource reason)
setShape in class IltAbstractLink
public void setShapeInManager(IltGraphicManager manager,
IltGraphic graphic,
IlpPolyline shape,
IlpPositionSource reason,
boolean assumeVisible)
setShapeInManager in class IltAbstractLinkmanager - the manager where to set the shapegraphic - the composite graphic representing the link in the managershape - the open polyline to use for the shape, in manager coordinatesreason - the reason for the shape change, or null if unknownassumeVisible - true if the graphic object is known become visible soonpublic void removeGraphic(IltGraphicManager manager)
Note that this method is not supposed to be used when this
IltLinkBundle is in a DataSource.
removeGraphic in class IltAbstractLink
public void setFrom(IltGraphicManager manager,
IltObject from)
setFrom in class IltAbstractLinkmanager - the manager where to change the link's from endfrom - the new from end of the link
public void setTo(IltGraphicManager manager,
IltObject to)
setTo in class IltAbstractLinkmanager - the manager where to change the link's to endto - the new to end of the link
public float getWidth(IltGraphicManager manager,
IltGraphic graphic)
IltAbstractLink
getWidth in class IltAbstractLink
public void setLinkLayoutProxyPresent(IltGraphicManager manager,
boolean layoutable)
IltAbstractLink
setLinkLayoutProxyPresent in class IltAbstractLinkpublic float getLinkDistance(IltGraphicManager manager)
linkDistance instead.
manager - the manager where the link bundle's link distance is queried
Note that this method is not supposed to be used when this
IltLinkBundle is in a DataSource.