ilog.cpl.graphic
Interface IlpGraphicHolder

All Known Implementing Classes:

IlpDefaultGraphicHolder, IlpEmptyGraphicHolder

public interface IlpGraphicHolder

This interface defines methods to associate IlpGraphic instances with attributes and objects.

Since:

JTGO 3.0

Method Summary

void	addGraphic(IlpRepresentationObject o, IlpAttribute a, IlpGraphic g) Associates the given representation object and attribute with the given graphic representation.
void	addGraphic(IlpRepresentationObject o, IlpGraphic g) Associates the given representation object with the given graphic representation.
IlpGraphic	getGraphic(IlpRepresentationObject o) Gets the graphic object associated with the given representation object.
IlpGraphic	getGraphic(IlpRepresentationObject o, IlpAttribute a) Gets the graphic object associated with the given representation object and attribute.
IlpGraphicRendererContext	getRendererContext(IlpRepresentationObject o) Returns the renderer context associated with the graphic representation of the given representation object.
IlpGraphicRendererContext	getRendererContext(IlpRepresentationObject o, IlpAttribute a) Returns the renderer context associated with the graphic representation of the given representation object and attribute.
void	invalidate() Invalidates all graphic instances present in this holder.
void	invalidateGraphic(IlpRepresentationObject o) Invalidates the graphic instance associated with the given representation object.
void	invalidateGraphic(IlpRepresentationObject o, IlpAttribute a) Invalidates the graphic instance associated with the given representation object and attribute.
boolean	isValid(IlpRepresentationObject o) Returns whether the graphic instance associated with the given representation object is valid.
boolean	isValid(IlpRepresentationObject o, IlpAttribute a) Returns whether the graphic instance associated with the given representation object and attribute is valid.
void	removeGraphic(IlpRepresentationObject o) Removes the graphic instance associated with the given representation object.
void	removeGraphic(IlpRepresentationObject o, IlpAttribute a) Removes the graphic instance associated with the given representation object and attribute.
void	validateGraphic(IlpRepresentationObject o, IlpAttribute a, IlpGraphicRendererContext c) Validates the graphic instance associated with the given representation object and attribute.
void	validateGraphic(IlpRepresentationObject o, IlpGraphicRendererContext c) Validates the graphic instance associated with the given representation object.

Method Detail

getGraphic

IlpGraphic getGraphic(IlpRepresentationObject o)

Gets the graphic object associated with the given representation object. May be null if the object only has graphics associated with individual attributes.

Parameters:

o - Representation object which graphic representation is being requested

getGraphic

IlpGraphic getGraphic(IlpRepresentationObject o,
                      IlpAttribute a)

Gets the graphic object associated with the given representation object and attribute. May be null if the attribute does not have a graphic representation.

Parameters:

o - Representation object

a - Attribute which graphic representation is being requested

addGraphic

void addGraphic(IlpRepresentationObject o,
                IlpGraphic g)

Associates the given representation object with the given graphic representation.

Parameters:

o - Representation object which graphic representation is being added

g - Graphic representation

addGraphic

void addGraphic(IlpRepresentationObject o,
                IlpAttribute a,
                IlpGraphic g)

Associates the given representation object and attribute with the given graphic representation.

Parameters:

o - Representation object

a - Attribute which graphic representation is being added

g - Graphic representation

removeGraphic

void removeGraphic(IlpRepresentationObject o)

Removes the graphic instance associated with the given representation object.

Parameters:

o - Representation object which graphic instance is being removed

removeGraphic

void removeGraphic(IlpRepresentationObject o,
                   IlpAttribute a)

Removes the graphic instance associated with the given representation object and attribute.

Parameters:

o - Representation object which graphic instance is being removed

a - Attribute which graphic instance is being removed

invalidateGraphic

void invalidateGraphic(IlpRepresentationObject o)

Invalidates the graphic instance associated with the given representation object.

Parameters:

o - Representation object which graphic instance is being invalidated

Since:

JTGO 3.1

invalidateGraphic

void invalidateGraphic(IlpRepresentationObject o,
                       IlpAttribute a)

Invalidates the graphic instance associated with the given representation object and attribute.

Parameters:

o - Representation object

a - Attribute which graphic instance is being invalidated

Since:

JTGO 3.1

invalidate

void invalidate()

Invalidates all graphic instances present in this holder.

Since:

JTGO 3.5

validateGraphic

void validateGraphic(IlpRepresentationObject o,
                     IlpGraphicRendererContext c)

Validates the graphic instance associated with the given representation object.

Parameters:

o - Representation object which graphic is being validated.

c - Renderer context information that is stored with the representation object graphic. This information is later used to indicate whether the graphic must be updated or not.

Since:

JTGO 3.1

validateGraphic

void validateGraphic(IlpRepresentationObject o,
                     IlpAttribute a,
                     IlpGraphicRendererContext c)

Validates the graphic instance associated with the given representation object and attribute.

Parameters:

o - Representation object

a - Attribute which graphic instance is being validated

c - Renderer context information that is stored with the representation object graphic. This information is later used to indicate whether the graphic must be updated or not.

Since:

JTGO 3.1

getRendererContext

IlpGraphicRendererContext getRendererContext(IlpRepresentationObject o)

Returns the renderer context associated with the graphic representation of the given representation object.

May be null if the graphic renderer context was not set.

Parameters:

o - Representation object which graphic validity is being queried

Since:

JTGO 3.1

See Also:

validateGraphic(ilog.cpl.model.IlpRepresentationObject, ilog.cpl.graphic.IlpGraphicRendererContext)

getRendererContext

IlpGraphicRendererContext getRendererContext(IlpRepresentationObject o,
                                             IlpAttribute a)

Returns the renderer context associated with the graphic representation of the given representation object and attribute.

May be null if the graphic renderer context was not set.

Parameters:

o - Representation object which graphic validity is being queried

a - Attribute which graphic representation is being validated

Since:

JTGO 3.1

See Also:

validateGraphic(ilog.cpl.model.IlpRepresentationObject, ilog.cpl.graphic.IlpGraphicRendererContext)

isValid

boolean isValid(IlpRepresentationObject o)

Returns whether the graphic instance associated with the given representation object is valid. Invalid graphic representations need to be updated.

Parameters:

o - Representation object which graphic validity is being queried

Since:

JTGO 3.1

isValid

boolean isValid(IlpRepresentationObject o,
                IlpAttribute a)

Returns whether the graphic instance associated with the given representation object and attribute is valid. Invalid graphic representations need to be updated.

Parameters:

o - Representation object

a - Attribute which graphic validity is being queried

Since:

JTGO 3.1