ilog.tgo.graphic

Class IltLayerPolicy

java.lang.Object

ilog.tgo.composite.IltcLayerPolicy

ilog.tgo.graphic.IltLayerPolicy

Direct Known Subclasses:

IltCompositeGrapher.LayerPolicy

public abstract class IltLayerPolicy
extends IltcLayerPolicy

This class decides about the layer in which a composite object is placed, unless a layer is specified explicitly. An instance of this class is associated to every IltCompositeGrapher instance.

Constructor Summary

Constructors

Constructor and Description
IltLayerPolicy()

Method Summary

Modifier and Type	Method and Description
void	attach(IltcCompositeManager manager) Attaches this layer policy to the manager.
void	detach(IltcCompositeManager manager) Detaches the layer policy from the manager and dispose its contents.
abstract IltcLayer	getDefaultLayer(IltcCompositeGraphic graphic) Returns the default layer to be used when adding a composite object to the manager.
IltcLayer	getElementLayer(IltcCompositeGraphic graphic, ilog.tgo.composite.internal.IltcGraphicElement g) Implementation of a deprecated method of the superclass.
abstract IltcLayer	getElementLayer(IltcCompositeGraphic graphic, IltGraphicElementName elementName) Returns the layer to be used for a specific graphic element, part of a composite object.
abstract boolean	isRemovable(IltcLayer layer) Returns true if the specified layer is free to be removed from the manager.

Methods inherited from class ilog.tgo.composite.IltcLayerPolicy

getDefaultLayer, getSubNetworkLayer

Methods inherited from class java.lang.Object

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

Constructor Detail

IltLayerPolicy

public IltLayerPolicy()

Method Detail

getDefaultLayer

public abstract IltcLayer getDefaultLayer(IltcCompositeGraphic graphic)

Returns the default layer to be used when adding a composite object to the manager.

Specified by:

getDefaultLayer in class IltcLayerPolicy

getElementLayer

public abstract IltcLayer getElementLayer(IltcCompositeGraphic graphic,
                                          IltGraphicElementName elementName)

Returns the layer to be used for a specific graphic element, part of a composite object. null means to use the composite object's layer.

getElementLayer

public IltcLayer getElementLayer(IltcCompositeGraphic graphic,
                                 ilog.tgo.composite.internal.IltcGraphicElement g)

Implementation of a deprecated method of the superclass.

Overrides:

getElementLayer in class IltcLayerPolicy

Internal: do not use!

isRemovable

public abstract boolean isRemovable(IltcLayer layer)

Returns true if the specified layer is free to be removed from the manager.

Specified by:

isRemovable in class IltcLayerPolicy

attach

public void attach(IltcCompositeManager manager)

Attaches this layer policy to the manager.

This method is called when the layer policy is set in a IltCompositeGrapher.

This method is responsible for performing any layer creation or initialization.

Specified by:

attach in class IltcLayerPolicy

Since:

JTGO 4.5

See Also:

detach(ilog.tgo.composite.IltcCompositeManager), IltCompositeGrapher.setLayerPolicy(IltcLayerPolicy)

detach

public void detach(IltcCompositeManager manager)

Detaches the layer policy from the manager and dispose its contents.

This method is called when the layer policy is being replaced.

This method is responsible for performing any layer clean up. All layers created by this layer policy should be removed in this method.

Specified by:

detach in class IltcLayerPolicy

Since:

JTGO 4.5

See Also:

attach(ilog.tgo.composite.IltcCompositeManager), IltCompositeGrapher.setLayerPolicy(IltcLayerPolicy)