ilog.cpl.graphic
Interface IlpGraphic

All Superinterfaces:

IlpAttachable, IlpGraphicContainment

All Known Implementing Classes:

IlpAbstractGraphic, IlpAlarmBalloon, IlpBalloon, IlpCentered, IlpCompositeGraphic, IlpInfoBalloon, IlpLeafGraphic, IlpStacker, IltcCompositeGraphic, ilog.tgo.composite.internal.IltcGraphicChild, IltcGraphicElementAggregate, IltCompositeGraphic, IltGraphicElementAggregate

public interface IlpGraphic
extends IlpAttachable, IlpGraphicContainment

This interface models the basic graphic used to create complex representations for CPL objects.

Since:

JTGO 3.0

Field Summary

static IlpColorKey	AlarmBalloonBorderColor Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.
static IlpColorKey	AlarmBalloonColor Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.
static IlpSwingConstantKey	AlarmBalloonOrientation Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.
static IlpIntegerKey	AlarmBalloonPointerDepth Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.
static IlpIntegerKey	AlarmBalloonPointerDistance Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.
static IlpIntegerKey	AlarmBalloonRadius Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.
static IlpColorKey	AlarmBalloonShadowColor Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.
static IlpIntegerKey	AlarmBalloonShadowThickness Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.
static IlpColorKey	AlarmCountLabelBackgroundColor Designates the color used to fill the alarm count graphic label background.
static IlpColorKey	AlarmCountOuterBorderColor Designates the color used to fill the alarm count graphic outer border.
static IlpIntegerKey	CenteredInsets Deprecated. IlpCentered has been replaced by the use of ILOG JViews Composite Graphic with a centered layout.
static IlpColorKey	InfoBalloonBorderColor Deprecated. IlpInfoBalloon has been replaced by the use of IlvRectBalloon and ILOG JViews Composite Graphics.
static IlpColorKey	InfoBalloonColor Deprecated. IlpInfoBalloon has been replaced by the use of IlvRectBalloon and ILOG JViews Composite Graphics.
static IlpSwingConstantKey	InfoBalloonOrientation Deprecated. IlpInfoBalloon has been replaced by the use of IlvRectBalloon and ILOG JViews Composite Graphics.
static IlpIntegerKey	InfoBalloonPointerDepth Deprecated. IlpInfoBalloon has been replaced by the use of IlvRectBalloon and ILOG JViews Composite Graphics.
static IlpColorKey	InfoBalloonShadowColor Deprecated. IlpInfoBalloon has been replaced by the use of IlvRectBalloon and ILOG JViews Composite Graphics.
static IlpIntegerKey	InfoBalloonShadowThickness Deprecated. IlpInfoBalloon has been replaced by the use of IlvRectBalloon and ILOG JViews Composite Graphics.
static IlpSwingConstantKey	StackerAlignment Deprecated. IlpStacker has been replaced by the use of ILOG JViews Composite Graphic with stacker layout.
static IlpSwingConstantKey	StackerOrientation Deprecated. IlpStacker has been replaced by the use of ILOG JViews Composite Graphic with stacker layout.
static IlpIntegerKey	StackerSpacing Deprecated. IlpStacker has been replaced by the use of ILOG JViews Composite Graphic with stacker layout.

Method Summary

void	addGraphicChangeListener(GraphicChangeListener l) Adds a new listener to this graphic.
boolean	contains(Point p) Checks whether this component "contains" the specified point, which is defined relative to the coordinate system of this component.
void	fireEvent(GraphicChangeEvent ev) Fires a change event to the listeners.
IlpAttribute	getAttribute() Returns the attribute that this graphic is representing, if there is one.
JComponent	getComponent() Returns the Java component responsible for the display of this graphic.
IlpGraphic	getParent() Returns the parent graphic.
IlpRepresentationObject	getRepresentationObject() Returns the object that this instance is representing.
IlpGraphicView	getView() Returns the view in which this graphic is being used.
void	removeGraphicChangeListener(GraphicChangeListener l) Removes a listener from the list.
void	setParent(IlpGraphic g) Sets the parent graphic.

Methods inherited from interface ilog.cpl.graphic.attachment.IlpAttachable

computeAttachmentCoordinates, computeFixedCoordinates, getAttachmentBounds, getAttachmentManager

Methods inherited from interface ilog.cpl.graphic.IlpGraphicContainment

addChild, getChildCount, getChildren, removeChild, removeChildren

Field Detail

CenteredInsets

static final IlpIntegerKey CenteredInsets

Deprecated. IlpCentered has been replaced by the use of ILOG JViews Composite Graphic with a centered layout.

Designates the insets used when a graphic instance is added inside another component. This key is to be used in the style of a representation object * or of an attribute. Its value is of type Integer.

Default value: 0.

See Also:

IlpAttributeCustomization.getCenteredInsets(), IlpCentered, IlvCompositeGraphic, IlvCenteredLayout

Deprecated Since:

JTGO 3.5

StackerSpacing

static final IlpIntegerKey StackerSpacing

Deprecated. IlpStacker has been replaced by the use of ILOG JViews Composite Graphic with stacker layout.

Designates the space between elements inside a stacker graphic. This key is to be used in the style of a representation object or of an attribute. Its value is of type Integer.

Default value: 3.

See Also:

IlpAttributeCustomization.getStackerSpacing(), IlpStacker, IlvCompositeGraphic, IlvStackerLayout

Deprecated Since:

JTGO 3.5

StackerOrientation

static final IlpSwingConstantKey StackerOrientation

Deprecated. IlpStacker has been replaced by the use of ILOG JViews Composite Graphic with stacker layout.

Designates the orientation of the stacker; in other words, the order that will be used to position the elements inside the stacker graphic. This key is to be used in the style of a representation object or of an attribute. The possible values are:

• SwingConstants.TOP
• SwingConstants.BOTTOM
• SwingConstants.RIGHT
• SwingConstants.LEFT

Default value: SwingConstants.RIGHT

See Also:

IlpAttributeCustomization.getStackerOrientation(), IlpStacker, IlvCompositeGraphic, IlvStackerLayout

Deprecated Since:

JTGO 3.5

StackerAlignment

static final IlpSwingConstantKey StackerAlignment

Deprecated. IlpStacker has been replaced by the use of ILOG JViews Composite Graphic with stacker layout.

Designates the alignment of the elements inside the stacker. This key is to be used in the style of a representation object or of an attribute. The possible values are:

• SwingConstants.TOP
• SwingConstants.BOTTOM
• SwingConstants.RIGHT
• SwingConstants.LEFT
• SwingConstants.CENTER

Default value: SwingConstants.CENTER.

See Also:

IlpAttributeCustomization.getStackerAlignment(), IlpStacker, IlvCompositeGraphic, IlvStackerLayout

Deprecated Since:

JTGO 3.5

InfoBalloonShadowThickness

static final IlpIntegerKey InfoBalloonShadowThickness

Deprecated. IlpInfoBalloon has been replaced by the use of IlvRectBalloon and ILOG JViews Composite Graphics.

Designates the thickness used to paint the shadow around the component. This key is to be used in the style of a representation object or of an attribute. Its value is of type Integer.

See Also:

Default value: 0., IlpAttributeCustomization.getInfoBalloonShadowThickness(), IlvCompositeGraphic

Deprecated Since:

JTGO 3.5

InfoBalloonPointerDepth

static final IlpIntegerKey InfoBalloonPointerDepth

Deprecated. IlpInfoBalloon has been replaced by the use of IlvRectBalloon and ILOG JViews Composite Graphics.

Designates the size of the balloon pointer. This key is to be used in the style of a representation object or of an attribute.

Default value: 0.

See Also:

IlpAttributeCustomization.getInfoBalloonPointerDepth(), IlpInfoBalloon, IlvCompositeGraphic

Deprecated Since:

JTGO 3.5

InfoBalloonOrientation

static final IlpSwingConstantKey InfoBalloonOrientation

Deprecated. IlpInfoBalloon has been replaced by the use of IlvRectBalloon and ILOG JViews Composite Graphics.

Designates the orientation of the balloon around its base graphic. This key is to be used in the style of a representation object or of an attribute.

The possible values are:

• SwingConstants.NORTH_EAST
• SwingConstants.NORTH_WEST
• SwingConstants.SOUTH_EAST
• SwingConstants.SOUTH_WEST
• SwingConstants.EAST
• SwingConstants.WEST

Default value: SwingConstants.NORTH_EAST.

See Also:

IlpAttributeCustomization.getInfoBalloonOrientation(), IlpInfoBalloon, IlvCompositeGraphic

Deprecated Since:

JTGO 3.5

InfoBalloonColor

static final IlpColorKey InfoBalloonColor

Deprecated. IlpInfoBalloon has been replaced by the use of IlvRectBalloon and ILOG JViews Composite Graphics.

Designates the background color used to paint the balloon graphic. This key is to be used in the style of a representation object or of an attribute.

Default value: Color.white.

See Also:

IlpAttributeCustomization.getInfoBalloonColor(), IlpInfoBalloon, IlvCompositeGraphic

Deprecated Since:

JTGO 3.5

InfoBalloonShadowColor

static final IlpColorKey InfoBalloonShadowColor

Deprecated. IlpInfoBalloon has been replaced by the use of IlvRectBalloon and ILOG JViews Composite Graphics.

Designates the color used to paint the shadow in a balloon graphic. This key is to be used in the style of a representation object or of an attribute.

Default value: Color.white.

See Also:

IlpAttributeCustomization.getInfoBalloonShadowColor(), IlpInfoBalloon, IlvCompositeGraphic

Deprecated Since:

JTGO 3.5

InfoBalloonBorderColor

static final IlpColorKey InfoBalloonBorderColor

Deprecated. IlpInfoBalloon has been replaced by the use of IlvRectBalloon and ILOG JViews Composite Graphics.

Designates the color used to paint the border in a balloon graphic. This key is to be used in the style of a representation object or of an attribute.

Default value: Color.black.

See Also:

IlpAttributeCustomization.getInfoBalloonBorderColor(), IlpInfoBalloon, IlvCompositeGraphic

Deprecated Since:

JTGO 3.5

AlarmBalloonShadowThickness

static final IlpIntegerKey AlarmBalloonShadowThickness

Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.

Designates the thickness used to paint the shadow around the component. This key is to be used in the style of a representation object or of an attribute. Its value is of type Integer.

Default value: 0.

See Also:

IlpAlarmBalloon, IlpAttributeCustomization.getAlarmBalloonShadowThickness(), IlvCompositeGraphic

Deprecated Since:

JTGO 3.5

AlarmBalloonPointerDepth

static final IlpIntegerKey AlarmBalloonPointerDepth

Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.

Designates the size of the balloon pointer. This key is to be used in the style of a representation object or of an attribute.

Default value: 0.

See Also:

IlpAlarmBalloon, IlpAttributeCustomization.getAlarmBalloonPointerDepth(), IlvCompositeGraphic

Deprecated Since:

JTGO 3.5

AlarmBalloonOrientation

static final IlpSwingConstantKey AlarmBalloonOrientation

Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.

Designates the orientation of the balloon around its base graphic. This key is to be used in the style of a representation object or of an attribute. The possible values are:

• SwingConstants.NORTH_EAST
• SwingConstants.NORTH_WEST
• SwingConstants.SOUTH_EAST
• SwingConstants.SOUTH_WEST
• SwingConstants.EAST
• SwingConstants.WEST

Default value: SwingConstants.NORTH_EAST.

See Also:

IlpAttributeCustomization.getAlarmBalloonOrientation(), IlpAlarmBalloon, IlvCompositeGraphic

Deprecated Since:

JTGO 3.5

AlarmBalloonColor

static final IlpColorKey AlarmBalloonColor

Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.

Designates the background color used to paint the balloon graphic. This key is to be used in the style of a representation object or of an attribute.

Default value: Color.white.

See Also:

IlpAttributeCustomization.getAlarmBalloonColor(), IlpAlarmBalloon, IlvCompositeGraphic

Deprecated Since:

JTGO 3.5

AlarmBalloonShadowColor

static final IlpColorKey AlarmBalloonShadowColor

Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.

Designates the color used to paint the shadow in a balloon graphic. This key is to be used in the style of a representation object or of an attribute.

Default value: Color.white.

See Also:

IlpAttributeCustomization.getAlarmBalloonShadowColor(), IlpAlarmBalloon, IlvCompositeGraphic

Deprecated Since:

JTGO 3.5

AlarmBalloonBorderColor

static final IlpColorKey AlarmBalloonBorderColor

Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.

Designates the color used to paint the border in a balloon graphic. This key is to be used in the style of a representation object or of an attribute.

Default value: Color.black.

See Also:

IlpAttributeCustomization.getAlarmBalloonBorderColor(), IlpAlarmBalloon, IlvCompositeGraphic

Deprecated Since:

JTGO 3.5

AlarmBalloonRadius

static final IlpIntegerKey AlarmBalloonRadius

Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.

Designates the radius used to draw round rectangle balloons. This key is to be used in the style of a representation object or of an attribute.

Default value: 0.

See Also:

IlpAttributeCustomization.getAlarmBalloonRadius(), IlpAlarmBalloon, IlvCompositeGraphic

Deprecated Since:

JTGO 3.5

AlarmBalloonPointerDistance

static final IlpIntegerKey AlarmBalloonPointerDistance

Deprecated. IlpInfoBalloon has been replaced by the use of IlvRoundRectBalloon and ILOG JViews Composite Graphics.

Designates distance from the left balloon face. This key is to be used in the style of a representation object or of an attribute. By default, the alarm balloon pointer is displayed in the middle of the alarm balloon face. Setting this style value modifies the default behavior.

Default value: 0.

See Also:

IlpAttributeCustomization.getAlarmBalloonPointerDistance(), IlpAlarmBalloon, IlvCompositeGraphic

Deprecated Since:

JTGO 3.5

AlarmCountLabelBackgroundColor

static final IlpColorKey AlarmCountLabelBackgroundColor

Designates the color used to fill the alarm count graphic label background.

Since:

JTGO 4.0

See Also:

IltDefaultAlarmCountGraphic

Internal method or field: do not use!

AlarmCountOuterBorderColor

static final IlpColorKey AlarmCountOuterBorderColor

Designates the color used to fill the alarm count graphic outer border.

Since:

JTGO 4.0

See Also:

IltDefaultAlarmCountGraphic

Internal method or field: do not use!

Method Detail

getView

IlpGraphicView getView()

Returns the view in which this graphic is being used.

getRepresentationObject

IlpRepresentationObject getRepresentationObject()

Returns the object that this instance is representing.

getAttribute

IlpAttribute getAttribute()

Returns the attribute that this graphic is representing, if there is one.

getComponent

JComponent getComponent()

Returns the Java component responsible for the display of this graphic.

getParent

IlpGraphic getParent()

Returns the parent graphic.

setParent

void setParent(IlpGraphic g)

Sets the parent graphic.

contains

boolean contains(Point p)

Checks whether this component "contains" the specified point, which is defined relative to the coordinate system of this component.

addGraphicChangeListener

void addGraphicChangeListener(GraphicChangeListener l)

Adds a new listener to this graphic.

removeGraphicChangeListener

void removeGraphicChangeListener(GraphicChangeListener l)

Removes a listener from the list.

fireEvent

void fireEvent(GraphicChangeEvent ev)

Fires a change event to the listeners.