IltCompositeGrapher.LayerPolicy (Perforce JViews 10.0 API)

java.lang.Object
- ilog.tgo.composite.IltcLayerPolicy
- - ilog.tgo.graphic.IltLayerPolicy
  - - ilog.tgo.graphic.IltCompositeGrapher.LayerPolicy

Enclosing class:

IltCompositeGrapher
```
public static class IltCompositeGrapher.LayerPolicy
extends IltLayerPolicy
```
This class implements the layer policy for JTGO objects. All network elements, off-page connectors, standalone shelf items and standalone card items go on one layer (main layer); all links go on a layer below the main layer (link layer); all shelves and their children items go on a layer below the link layer (shelf layer); all standalone card carriers and cards (and their children items) go on a layer below the shelf layer (card layer); all groups go on a layer below the card layer. The alarm balloons and information windows stand out on top of the other objects. Information windows are always on the very top.
For a typical subclass, you will probably have to write the following code:
1. A list of protected IltcLayer members that reference the layers used by the layer policy.
2. A constructor that allocates the IltcLayer members by using the methods addLayerOnTop and addLayerAtBottom. To position new layers between existing layers, use addLayerBelow and pass as an argument the result of one of the layer accessors.
3. A getDefaultLayer method that returns a layer according to the object being changed.
4. Optionally, a getElementLayer method if you want to change the layering of the graphic elements of a given composite graphic.

Field Summary

Fields
Modifier and Type	Field and Description
`protected IltcLayer`	`_alarmBalloonLayer`
`protected IltcLayer`	`_cardLayer`
`protected IltcLayer`	`_groupLayer`
`protected IltcLayer`	`_infoWindowLayer`
`protected IltcLayer`	`_linkLayer`
`protected IltcLayer`	`_mainLayer`
`protected IltcCompositeManager`	`_manager`
`protected IltcLayer`	`_secondaryStateModifiersLayer`
`protected IltcLayer`	`_shelfLayer`
`protected IlvManagerLayer`	`_subNetworkLayer`
`protected IltcLayer`	`_systemWindowLayer`

Constructor Summary

Constructors
Constructor and Description

LayerPolicy()
Create a new layer policy.

LayerPolicy(IltcCompositeManager manager)
Creates a new layer policy.

Constructors
Constructor and Description
`LayerPolicy()` Create a new layer policy.
`LayerPolicy(IltcCompositeManager manager)` Creates a new layer policy.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`attach(IltcCompositeManager mgr)` Attaches the layer policy to the given manager.
`void`	`detach(IltcCompositeManager cmgr)` Detaches the layer policy from the given manager.
`IltcLayer`	`getAlarmBalloonLayer()` Returns the layer which holds the alarm balloons of all objects.
`IltcLayer`	`getCardLayer()` Returns the layer which holds the card carriers and composite cards, including all its items.
`IltcLayer`	`getDefaultLayer(IltcCompositeGraphic graphic)` Returns the default layer for a given graphic.
`IltcLayer`	`getElementLayer(IltcCompositeGraphic graphic, IltGraphicElementName elementName)` Returns the layer to be used for a specific graphic element, part of a composite object.
`IltcLayer`	`getGroupLayer()` Returns the layer which holds the groups.
`IltcLayer`	`getInfoWindowLayer()` Returns the layer which holds the information windows of all objects.
`protected IltcLayer`	`getLayerOf(IltObject object)` Returns the layer of a given object in this manager, if it is visible.
`IltcLayer`	`getLinkLayer()` Returns the layer which holds the links.
`IltcLayer`	`getMainLayer()` Returns the layer which holds the base of network elements, off-page connectors, shelves and stand-alone shelf items.
`IltcLayer`	`getSecondaryStateModifiersLayer()` Returns the layer which holds the secondary states of all objects.
`IltcLayer`	`getShelfLayer()` Returns the layer which holds the shelves and its items.
`IlvManagerLayer`	`getSubNetworkLayer()` Returns the layer which holds the subgraphers.
`IltcLayer`	`getSystemWindowLayer()` Returns the layer which holds the system windows of all objects.
`boolean`	`isRemovable(IltcLayer layer)` Returns `true` if the specified layer is free to be removed from the manager.

Methods inherited from class ilog.tgo.graphic.IltLayerPolicy
getElementLayer

Methods inherited from class ilog.tgo.composite.IltcLayerPolicy
getDefaultLayer

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _manager
```
protected IltcCompositeManager _manager
```
    Internal: do not use!
  - _subNetworkLayer
```
protected IlvManagerLayer _subNetworkLayer
```
    Internal: do not use!
  - _groupLayer
```
protected IltcLayer _groupLayer
```
    Internal: do not use!
  - _cardLayer
```
protected IltcLayer _cardLayer
```
    Internal: do not use!
  - _shelfLayer
```
protected IltcLayer _shelfLayer
```
    Internal: do not use!
  - _linkLayer
```
protected IltcLayer _linkLayer
```
    Internal: do not use!
  - _mainLayer
```
protected IltcLayer _mainLayer
```
    Internal: do not use!
  - _secondaryStateModifiersLayer
```
protected IltcLayer _secondaryStateModifiersLayer
```
    Internal: do not use!
  - _alarmBalloonLayer
```
protected IltcLayer _alarmBalloonLayer
```
    Internal: do not use!
  - _infoWindowLayer
```
protected IltcLayer _infoWindowLayer
```
    Internal: do not use!
  - _systemWindowLayer
```
protected IltcLayer _systemWindowLayer
```
    Internal: do not use!
- Constructor Detail
  - LayerPolicy
```
public LayerPolicy(IltcCompositeManager manager)
```
    Creates a new layer policy.
    Special layers will be allocated to place the different decorations. The layers are created when the layer policy is attached to the manager (See attach(ilog.tgo.composite.IltcCompositeManager))
    
    Layers will be created in the following order:
    - Subnetworks
    - Groups
    - Cards
    - Shelves
    - Links
    - Other base objects
    - Secondary state decorations
    - Alarm balloon decorations
    - Information window decorations
    - System window decorations
  - LayerPolicy
```
public LayerPolicy()
```
    Create a new layer policy.
    Special layers will be allocated to place the different decorations. The layers are created when the layer policy is attached to the manager.
    
    Layers will be created in the following order:
    - Subnetworks
    - Groups
    - Cards
    - Shelves
    - Links
    - Other base objects
    - Secondary state decorations
    - Alarm balloon decorations
    - Information window decorations
    - System window decorations
    Since:
    
    JTGO 4.5
- Method Detail
  - getDefaultLayer
```
public IltcLayer getDefaultLayer(IltcCompositeGraphic graphic)
```
    Returns the default layer for a given graphic.
    
    Specified by:
    
    getDefaultLayer in class IltLayerPolicy
  - getLayerOf
```
protected IltcLayer getLayerOf(IltObject object)
```
    Returns the layer of a given object in this manager, if it is visible.
    
    Internal: do not use!
  - getElementLayer
```
public IltcLayer getElementLayer(IltcCompositeGraphic graphic,
                                 IltGraphicElementName elementName)
```
    Description copied from class: IltLayerPolicy
    
    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.
    
    Specified by:
    
    getElementLayer in class IltLayerPolicy
    
    Internal: do not use!
  - isRemovable
```
public boolean isRemovable(IltcLayer layer)
```
    Returns true if the specified layer is free to be removed from the manager.
    
    Specified by:
    
    isRemovable in class IltLayerPolicy
  - attach
```
public void attach(IltcCompositeManager mgr)
```
    Attaches the layer policy to the given manager.
    This method performs all the needed initialization, for instance, creating new layers where the decorations will be placed.
    
    Overrides:
    
    attach in class IltLayerPolicy
    
    See Also:
    
    IltLayerPolicy.detach(ilog.tgo.composite.IltcCompositeManager), IltCompositeGrapher.setLayerPolicy(IltcLayerPolicy)
  - detach
```
public void detach(IltcCompositeManager cmgr)
```
    Detaches the layer policy from the given manager.
    This method performs all the needed clean up, removing the layers that have been added by this layer policy.
    
    Overrides:
    
    detach in class IltLayerPolicy
    
    See Also:
    
    IltLayerPolicy.attach(ilog.tgo.composite.IltcCompositeManager), IltCompositeGrapher.setLayerPolicy(IltcLayerPolicy)
  - getSubNetworkLayer
```
public IlvManagerLayer getSubNetworkLayer()
```
    Returns the layer which holds the subgraphers.
    
    Overrides:
    
    getSubNetworkLayer in class IltcLayerPolicy
  - getGroupLayer
```
public IltcLayer getGroupLayer()
```
    Returns the layer which holds the groups.
  - getCardLayer
```
public IltcLayer getCardLayer()
```
    Returns the layer which holds the card carriers and composite cards, including all its items.
  - getShelfLayer
```
public IltcLayer getShelfLayer()
```
    Returns the layer which holds the shelves and its items.
  - getLinkLayer
```
public IltcLayer getLinkLayer()
```
    Returns the layer which holds the links.
  - getMainLayer
```
public IltcLayer getMainLayer()
```
    Returns the layer which holds the base of network elements, off-page connectors, shelves and stand-alone shelf items.
  - getSecondaryStateModifiersLayer
```
public IltcLayer getSecondaryStateModifiersLayer()
```
    Returns the layer which holds the secondary states of all objects.
  - getAlarmBalloonLayer
```
public IltcLayer getAlarmBalloonLayer()
```
    Returns the layer which holds the alarm balloons of all objects.
  - getInfoWindowLayer
```
public IltcLayer getInfoWindowLayer()
```
    Returns the layer which holds the information windows of all objects.
  - getSystemWindowLayer
```
public IltcLayer getSystemWindowLayer()
```
    Returns the layer which holds the system windows of all objects.

Class IltCompositeGrapher.LayerPolicy

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ilog.tgo.graphic.IltLayerPolicy

Methods inherited from class ilog.tgo.composite.IltcLayerPolicy

Methods inherited from class java.lang.Object

Field Detail

_manager

_subNetworkLayer

_groupLayer

_cardLayer

_shelfLayer

_linkLayer

_mainLayer

_secondaryStateModifiersLayer

_alarmBalloonLayer

_infoWindowLayer

_systemWindowLayer

Constructor Detail

LayerPolicy

LayerPolicy

Method Detail

getDefaultLayer

getLayerOf

getElementLayer

isRemovable

attach

detach

getSubNetworkLayer

getGroupLayer

getCardLayer

getShelfLayer

getLinkLayer

getMainLayer

getSecondaryStateModifiersLayer

getAlarmBalloonLayer

getInfoWindowLayer

getSystemWindowLayer