ilog.tgo.graphic

Class IltCompositeInteractions

java.lang.Object

ilog.tgo.graphic.IltCompositeInteractions

Deprecated.

Since JTGO 3.0, object interactors are managed by the Controller element of each Graphic Component. Controllers are part of the MVC trio that composes a graphic component. It is responsible for storing and setting interactors to the view and its objects. Interactors can be defined using the Graphic Controller API or by loading cascading style sheets with Interactor definition. Concerning tooltips, their customization is now achieved only through CSS using properties toolTipText or toolTipGraphic. The toolTipGraphic property has priority.

@Deprecated
public class IltCompositeInteractions
extends Object

This class manages interactors that are positioned on elements of a composite graphic objects. It also permits to position an interactor on a composite graphic object as a whole.

Interactors positioned on a single element take precedence over interactors positioned on the composite graphic object as a whole.

See Also:

IlpObjectInteractor, IlpNetworkController, IlpEquipmentController, IlpTreeController, IlpTableController

Deprecated Since:

JTGO 4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected IltCompositeGraphic	_graphic Deprecated. The composite graphic object for which this object is responsible.
static IltToolTipFactory	ObjectLabelToolTipFactory Deprecated. Please use IlpToolTipManager and the CSS property toolTipText instead. The same feature can be achieved with the following CSS configuration: object."ilog.tgo.model.IltObject" { toolTipText: @name; }
static IltToolTipFactory	SecStateModifierToolTipFactory Deprecated. Please use IlpToolTipManager and CSS property toolTipGraphic instead. The same feature can be achieved with the following CSS configuration: object."ilog.tgo.model.IltObject/objectState" { toolTipGraphic: @+SecStateToolTipGraphic; } Subobject#SecStateToolTipGraphic { class: 'ilog.tgo.graphic.IltSecStateModifierToolTipGraphic'; }

Constructor Summary

Constructors

Constructor and Description
IltCompositeInteractions(IltCompositeGraphic graphic) Deprecated. Creates a new interaction manager for a composite graphic object.

Method Summary

Modifier and Type	Method and Description
IlvObjectInteractor	getElementFallbackInteractor(IltGraphicElementName elementName) Deprecated. Returns the fallback interactor for a graphic element.
IlvObjectInteractor	getElementInteractor(IltGraphicElementName elementName) Deprecated. Interactors are stored in the Controller component that is part of each graphic component. Interactors are no longer associated to graphic elements, instead they are associated to business attributes. Business attributes are graphically represented as decorations attached to the object base, for instance, the alarm balloon decoration is the graphic representation of attribute newAlarmCount in the Network component. Therefore, if you would like to add interactions to an alarm balloon, you should register an object interactor associated to this attribute. This feature is available in the Network, Equipment and Table components.
IltToolTipFactory	getElementToolTipFactory(IltGraphicElementName elementName) Deprecated. Please use IlpToolTipManager and the CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component. The tooltip is displayed in the decoration that represents the name attribute of the object. In the network, equipment and table components you can customize tooltips for: the whole object specific attributes that are displayed as decorations The following example shows how to customize a tooltip that is displayed on the decoration that represents the name of the object: object."ilog.tgo.model.IltNetworkElement/name" { toolTipText: "Network Element Name"; }
String	getElementToolTipText(IltGraphicElementName elementName) Deprecated. Please use IlpToolTipManager and the CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component. The tooltip is displayed in the decoration that represents the name attribute of the object. In the network, equipment and table components, you can customize tooltips for: the whole object specific attributes that are displayed as decorations The following example shows how to customize a tooltip that is displayed on the decoration that represents the name of the object: object."ilog.tgo.model.IltNetworkElement/name" { toolTipText: "Network Element Name"; }
IlvObjectInteractor	getFallbackInteractor() Deprecated. Returns the fallback interactor for the composite graphic object as a whole.
IlvObjectInteractor	getInteractor() Deprecated. Interactors are stored in the Controller component that is part of each graphic component.
IlvObjectInteractor	getInteractorOn(IltGraphicElementName elementName) Deprecated. Returns the interactor to be positioned on a given graphic element.
static IltObjectInteractorContext	GetObjectContext(IltGraphic composite, ilog.tgo.graphic.internal.IltGraphicElement element, IlvObjectInteractorContext origcontext) Deprecated. Returns an interactor context, containing information about the composite graphic object visible, the graphic element and the interactor context.
static IltObjectInteractorContext	GetObjectContext(IlvPoint p, IlvManagerView view) Deprecated. Returns an interactor context, containing information about the composite graphic object visible at a given point in a given view.
IltToolTipFactory	getToolTipFactory() Deprecated. Please use IlpToolTipManager and the CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component, using a CSS. This example shows the object name as a tooltip: object."ilog.tgo.model.IltNetworkElement" { toolTipText: @name; }
String	getToolTipText() Deprecated. Please use IlpToolTipManager and the CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component using a CSS. This example shows the object name as a tooltip: object."ilog.tgo.model.IltNetworkElement" { toolTipText: @name; }
void	setElementFallbackInteractor(IltGraphicElementName elementName, IlvObjectInteractor interactor) Deprecated. Sets the interactor for a graphic element.
void	setElementInteractor(IltGraphicElementName elementName, IlvObjectInteractor interactor) Deprecated. Interactors are stored in the Controller component that is part of each graphic component. Interactors are no longer associated to graphic elements, instead they are associated to business attributes. Business attributes are graphically represented as decorations attached to the object base, for instance, the alarm balloon decoration is the graphic representation of attribute newAlarmCount in the network component. Therefore, if you would like to add interactions to an alarm balloon, you should register an object interactor associated to this attribute. This feature is available in the Network, Equipment and Table components.
void	setElementToolTipFactory(IltGraphicElementName elementName, IltToolTipFactory factory) Deprecated. Please use IlpToolTipManager and CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component. The tooltip is displayed in the decoration that represents the name attribute of the object. In the network, equipment and table components, you can customize tooltips for: the whole object specific attributes that are displayed as decorations The following example shows how to customize a tooltip that is displayed on the decoration that represents the name of the object: object."ilog.tgo.model.IltNetworkElement/name" { toolTipText: "Network Element Name"; }
void	setElementToolTipText(IltGraphicElementName elementName, String text) Deprecated. Please use IlpToolTipManager and the CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component. The tooltip is displayed in the decoration that represents the name attribute of the object. In the network, equipment and table components, you can customize tooltips for: the whole object specific attributes that are displayed as decorations The following example shows how to customize a tooltip that is displayed on the decoration that represents the name of the object: object."ilog.tgo.model.IltNetworkElement/name" { toolTipText: "Network Element Name"; }
void	setFallbackInteractor(IlvObjectInteractor interactor) Deprecated. Sets the fallback interactor for the composite graphic object as a whole.
void	setInteractor(IlvObjectInteractor interactor) Deprecated. Interactors are stored in the Controller component that is part of each graphic component. You can customize object interactors using the Graphic controller API or using CSS.
void	setToolTipFactory(IltToolTipFactory factory) Deprecated. Please use IlpToolTipManager and the CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component using a CSS. This example shows the object name as a tooltip: object."ilog.tgo.model.IltNetworkElement" { toolTipText: @name; }
void	setToolTipText(String text) Deprecated. Please use IlpToolTipManager and the CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component using a CSS. This example shows the object name as a tooltip: object."ilog.tgo.model.IltNetworkElement" { toolTipText: @name; }

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_graphic

protected IltCompositeGraphic _graphic

Deprecated.

The composite graphic object for which this object is responsible.

Internal: do not use!

ObjectLabelToolTipFactory

@Deprecated
public static IltToolTipFactory ObjectLabelToolTipFactory

Deprecated. Please use IlpToolTipManager and the CSS property toolTipText instead. The same feature can be achieved with the following CSS configuration:

 object."ilog.tgo.model.IltObject" {
   toolTipText: @name;
 }
 

A tooltip factory that displays the label of the object that is pointed with the mouse.

Deprecated Since:

JTGO 4.0

SecStateModifierToolTipFactory

@Deprecated
public static IltToolTipFactory SecStateModifierToolTipFactory

Deprecated. Please use IlpToolTipManager and CSS property toolTipGraphic instead. The same feature can be achieved with the following CSS configuration:

 object."ilog.tgo.model.IltObject/objectState" {
   toolTipGraphic:  @+SecStateToolTipGraphic;
 }
 Subobject#SecStateToolTipGraphic {
   class: 'ilog.tgo.graphic.IltSecStateModifierToolTipGraphic';
 }
 

A tooltip factory which displays the description of the secondary state modifier that is pointed with the mouse.

See Also:

IltSecStateModifierToolTipGraphic

Deprecated Since:

JTGO 4.0

Constructor Detail

IltCompositeInteractions

public IltCompositeInteractions(IltCompositeGraphic graphic)

Deprecated.

Creates a new interaction manager for a composite graphic object.

Parameters:

graphic - the graphic object to which this manager will be attached

Internal: do not use!

Method Detail

getInteractor

@Deprecated
public IlvObjectInteractor getInteractor()

Deprecated. Interactors are stored in the Controller component that is part of each graphic component.

Returns the interactor for the composite graphic object as a whole.

See Also:

IlpInteractorManager.getObjectInteractor(java.lang.Object), IlpObjectInteractor

Deprecated Since:

JTGO 4.0

getFallbackInteractor

public IlvObjectInteractor getFallbackInteractor()

Deprecated.

Returns the fallback interactor for the composite graphic object as a whole.

Internal: do not use!

getElementInteractor

@Deprecated
public IlvObjectInteractor getElementInteractor(IltGraphicElementName elementName)

Deprecated. Interactors are stored in the Controller component that is part of each graphic component. Interactors are no longer associated to graphic elements, instead they are associated to business attributes. Business attributes are graphically represented as decorations attached to the object base, for instance, the alarm balloon decoration is the graphic representation of attribute newAlarmCount in the Network component. Therefore, if you would like to add interactions to an alarm balloon, you should register an object interactor associated to this attribute. This feature is available in the Network, Equipment and Table components.

Returns the interactor for a graphic element.

See Also:

IlpObjectInteractor, IlpInteractorManager.getObjectInteractor(IlpRepresentationObject,IlpAttribute)

Deprecated Since:

JTGO 4.0

getElementFallbackInteractor

public IlvObjectInteractor getElementFallbackInteractor(IltGraphicElementName elementName)

Deprecated.

Returns the fallback interactor for a graphic element.

Internal: do not use!

setInteractor

@Deprecated
public void setInteractor(IlvObjectInteractor interactor)

Deprecated. Interactors are stored in the Controller component that is part of each graphic component. You can customize object interactors using the Graphic controller API or using CSS.

Sets the interactor for the composite graphic object as a whole.

Note: The interactor context which will be passed to the interactor will be of type IltObjectInteractorContext, thus permitting the interactor to access the composite graphic object and the semantic object.

See Also:

IlpInteractorManager.getObjectInteractor(java.lang.Object), IlpObjectInteractor, IltObjectInteractorContext, IlpObjectCustomization.getInteractor()

Deprecated Since:

JTGO 4.0

setFallbackInteractor

public void setFallbackInteractor(IlvObjectInteractor interactor)

Deprecated.

Sets the fallback interactor for the composite graphic object as a whole.

Internal: do not use!

setElementInteractor

@Deprecated
public void setElementInteractor(IltGraphicElementName elementName,
                                             IlvObjectInteractor interactor)

Deprecated. Interactors are stored in the Controller component that is part of each graphic component. Interactors are no longer associated to graphic elements, instead they are associated to business attributes. Business attributes are graphically represented as decorations attached to the object base, for instance, the alarm balloon decoration is the graphic representation of attribute newAlarmCount in the network component. Therefore, if you would like to add interactions to an alarm balloon, you should register an object interactor associated to this attribute. This feature is available in the Network, Equipment and Table components.

Sets the interactor for a graphic element. The graphic element is specified by name. A graphic element having this name does not need to exist; when one will be added to the composite graphic object, the given interactor will be attached to it.

Note: The interactor context which will be passed to the interactor will be of type IltObjectInteractorContext, thus permitting the interactor to access the composite graphic object and the semantic object.

See Also:

IlpObjectInteractor, IlpInteractorManager.getObjectInteractor(IlpRepresentationObject,IlpAttribute), IltObjectInteractorContext, IlpAttributeCustomization.getInteractor()

Deprecated Since:

JTGO 4.0

setElementFallbackInteractor

public void setElementFallbackInteractor(IltGraphicElementName elementName,
                                         IlvObjectInteractor interactor)

Deprecated.

Sets the interactor for a graphic element. The graphic element is specified by name. A graphic element having this name does not need to exist; when one will be added to the composite graphic object, the given interactor will be attached to it.

Note: The interactor context which will be passed to the interactor will be of type IltObjectInteractorContext, thus permitting the interactor to access the composite graphic object and the semantic object.

See Also:

IltObjectInteractorContext

Internal: do not use!

getToolTipFactory

@Deprecated
public IltToolTipFactory getToolTipFactory()

Deprecated. Please use IlpToolTipManager and the CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component, using a CSS. This example shows the object name as a tooltip:

 object."ilog.tgo.model.IltNetworkElement" {
   toolTipText: @name;
 }
 

Returns the IltToolTipFactory for the composite graphic object as a whole.

Deprecated Since:

JTGO 4.0

getElementToolTipFactory

@Deprecated
public IltToolTipFactory getElementToolTipFactory(IltGraphicElementName elementName)

Deprecated. Please use IlpToolTipManager and the CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component. The tooltip is displayed in the decoration that represents the name attribute of the object. In the network, equipment and table components you can customize tooltips for:

• the whole object
• specific attributes that are displayed as decorations

The following example shows how to customize a tooltip that is displayed on the decoration that represents the name of the object:

 object."ilog.tgo.model.IltNetworkElement/name" {
   toolTipText: "Network Element Name";
 }
 

Returns the IltToolTipFactory of a graphic element.

Deprecated Since:

JTGO 4.0

setToolTipFactory

@Deprecated
public void setToolTipFactory(IltToolTipFactory factory)

Deprecated. Please use IlpToolTipManager and the CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component using a CSS. This example shows the object name as a tooltip:

 object."ilog.tgo.model.IltNetworkElement" {
   toolTipText: @name;
 }
 

Sets the IltToolTipFactory for the composite graphic object as a whole.

Note: The interactor context that will be passed to the tooltip factory will be of type IltObjectInteractorContext. This permits the factory to access the composite graphic object and the semantic object.

See Also:

IlpToolTipManager

Deprecated Since:

JTGO 4.0

setElementToolTipFactory

@Deprecated
public void setElementToolTipFactory(IltGraphicElementName elementName,
                                                 IltToolTipFactory factory)

Deprecated. Please use IlpToolTipManager and CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component. The tooltip is displayed in the decoration that represents the name attribute of the object. In the network, equipment and table components, you can customize tooltips for:

• the whole object
• specific attributes that are displayed as decorations

The following example shows how to customize a tooltip that is displayed on the decoration that represents the name of the object:

 object."ilog.tgo.model.IltNetworkElement/name" {
   toolTipText: "Network Element Name";
 }
 

Sets the IltToolTipFactory for a graphic element. The graphic element is specified by a name. A graphic element having this name does not need to exist; when one is added to the composite graphic object, the given ToolTipFactory will be attached to it.

Note: The interactor context that will be passed to the ToolTipFactory will be of type IltObjectInteractorContext. This will permit the factory to access the composite graphic object and the semantic object.

See Also:

IltToolTipManager

setToolTipText

@Deprecated
public void setToolTipText(String text)

Deprecated. Please use IlpToolTipManager and the CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component using a CSS. This example shows the object name as a tooltip:

 object."ilog.tgo.model.IltNetworkElement" {
   toolTipText: @name;
 }
 

Sets the tooltip for the composite graphic object as a whole.

This is equivalent to setting a factory that will create an IltTextToolTip with the given string.

See Also:

setToolTipFactory(ilog.tgo.graphic.IltToolTipFactory)

Deprecated Since:

JTGO 4.0

setElementToolTipText

@Deprecated
public void setElementToolTipText(IltGraphicElementName elementName,
                                              String text)

Deprecated. Please use IlpToolTipManager and the CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component. The tooltip is displayed in the decoration that represents the name attribute of the object. In the network, equipment and table components, you can customize tooltips for:

• the whole object
• specific attributes that are displayed as decorations

The following example shows how to customize a tooltip that is displayed on the decoration that represents the name of the object:

 object."ilog.tgo.model.IltNetworkElement/name" {
   toolTipText: "Network Element Name";
 }
 

Sets the tooltip for a graphic element. The graphic element is specified by name.

This is equivalent to setting a factory which will create an IltTextToolTip with the given string.

See Also:

setElementToolTipFactory(ilog.tgo.graphic.IltGraphicElementName, ilog.tgo.graphic.IltToolTipFactory)

Deprecated Since:

JTGO 4.0

getToolTipText

@Deprecated
public String getToolTipText()

Deprecated. Please use IlpToolTipManager and the CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component using a CSS. This example shows the object name as a tooltip:

 object."ilog.tgo.model.IltNetworkElement" {
   toolTipText: @name;
 }
 

Returns the tooltip text for the composite graphic object as a whole. Returns null if no text or no tooltip factory has been positioned.

Deprecated Since:

JTGO 4.0

getElementToolTipText

@Deprecated
public String getElementToolTipText(IltGraphicElementName elementName)

Deprecated. Please use IlpToolTipManager and the CSS properties toolTipText or toolTipGraphic instead. The following example illustrates how you can customize a tooltip for an object being represented in your graphic component. The tooltip is displayed in the decoration that represents the name attribute of the object. In the network, equipment and table components, you can customize tooltips for:

• the whole object
• specific attributes that are displayed as decorations

The following example shows how to customize a tooltip that is displayed on the decoration that represents the name of the object:

 object."ilog.tgo.model.IltNetworkElement/name" {
   toolTipText: "Network Element Name";
 }
 

Returns the tooltip text for a graphic element. The graphic element is specified by name. Returns null if no text or no tooltip factory has been positioned.

Deprecated Since:

JTGO 4.0

getInteractorOn

public IlvObjectInteractor getInteractorOn(IltGraphicElementName elementName)

Deprecated.

Returns the interactor to be positioned on a given graphic element. Note that neither does the "whole" interactor override the "element" interactor, nor vice versa. They are mixed in the following sense: For every event, first the "element" interactor is asked, and if it declines responsibility, then the "whole" interactor is asked.

Internal: do not use!

GetObjectContext

public static IltObjectInteractorContext GetObjectContext(IlvPoint p,
                                                          IlvManagerView view)

Deprecated.

Returns an interactor context, containing information about the composite graphic object visible at a given point in a given view.

Parameters:

p - the point, in view coordinates

view - the view

Returns:

an interactor context, or null if the point does not belong to a composite graphic object

GetObjectContext

public static IltObjectInteractorContext GetObjectContext(IltGraphic composite,
                                                          ilog.tgo.graphic.internal.IltGraphicElement element,
                                                          IlvObjectInteractorContext origcontext)

Deprecated.

Returns an interactor context, containing information about the composite graphic object visible, the graphic element and the interactor context.

Parameters:

composite - Graphic object.

element - Graphic element in the graphic object.

origcontext - Object interactor context.

Returns:

An interactor context, or null if the point does not belong to a composite graphic object.

Internal: do not use!