All Superinterfaces:

Service

All Known Subinterfaces:

PortableViewToc

All Known Implementing Classes:

DefaultPortableViewToc
```
public interface TOC
extends Service
```
This interface must be implemented by future TOC implementations. This is used following the Tools scheme (services, managers, etc)

See Also:

DefaultToc

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addActiveLayerChangeListener(ActiveLayerChangeEventListener alcel)` Adds a active layer change listener.
`void`	`addLayerActionListener(LayerActionEventListener lel)` Adds a layer action listener.
`void`	`addLegendActionListener(LegendActionEventListener lel)` Adds a legend action listener.
`void`	`clearSelection()` Clears current layer selection
`FLayer`	`getActiveLayer()`
`JComponent`	`getComponent()`
`TOCFactory`	`getFactory()`
`MapContext`	`getMapContext()`
`DynObject`	`getParameters()` Gets the parameters that were used to instantiate this TOC.
`FLayer[]`	`getSelectedLayers()`
`void`	`hideAll()` Hides as much as possible the graphic representation of the TOC (for example, collapses all the nodes to hide all layer details except the list of layers itself)
`void`	`hideAllLegends()` Collapses all graphic representation of layer legends
`void`	`hideLegend(FLayer lyr)` Makes layer legend details not visible
`void`	`invokeAction(FLayer lyr, String action)` Invokes a certain action on a certain layer
`void`	`removeActiveLayerChangeListener(ActiveLayerChangeEventListener alcel)` Removes a active layer change listener
`void`	`removeLayerActionListener(LayerActionEventListener lel)` Removes a layer action listener
`void`	`removeLegendActionListener(LegendActionEventListener lel)` Removes a legend action listener
`void`	`selectLayer(FLayer lyr)` Add a layer to the set of selected layers
`void`	`setActiveLayer(FLayer lyr)` Sets a layer as active (exclusively: the number of active layers must be 0 or 1)
`void`	`show(FLayer lyr, boolean detailed)` Makes the name and representation of a certain layer visible in the TOC.
`void`	`showAll()` Expands fully the graphic representation of the TOC (for example, expands all the nodes to show all layer details)
`void`	`showAllLegends()` Expands all graphic representation of layer legends
`void`	`showLegend(FLayer lyr)` Makes layer legend details visible
`void`	`unselectLayer(FLayer lyr)` Removes a layer from the set of selected layers

Methods inherited from interface org.gvsig.tools.service.Service
getManager

- Method Detail
  - getParameters
```
DynObject getParameters()
```
    Gets the parameters that were used to instantiate this TOC. Normally, the @see MapContext
    
    Returns:
    
    a dynobject containing the parameters
  - getFactory
```
TOCFactory getFactory()
```
    Returns:
    
    the TOCFactory that created this TOC.
  - getComponent
```
JComponent getComponent()
```
    Returns:
    
    the Swing component that represents this TOC (for example a JTree or a JPanel with a JTree in it)
  - getMapContext
```
MapContext getMapContext()
```
    Returns:
    
    the MapContext on which this TOC is necessarily based
  - showAll
```
void showAll()
```
    Expands fully the graphic representation of the TOC (for example, expands all the nodes to show all layer details)
  - hideAll
```
void hideAll()
```
    Hides as much as possible the graphic representation of the TOC (for example, collapses all the nodes to hide all layer details except the list of layers itself)
  - showAllLegends
```
void showAllLegends()
```
    Expands all graphic representation of layer legends
  - hideAllLegends
```
void hideAllLegends()
```
    Collapses all graphic representation of layer legends
  - show
```
void show(FLayer lyr,
          boolean detailed)
```
    Makes the name and representation of a certain layer visible in the TOC. For example, the TOC might be a JTree inside a scroll pane. This method would scroll down the scroll pane to let the user see the layer is listed
    
    Parameters:
    
    lyr - the layer whose name and details must be made visible
    
    detailed - whether the layer details must be shown or not
  - showLegend
```
void showLegend(FLayer lyr)
```
    Makes layer legend details visible
    
    Parameters:
    
    lyr - layer whose legend details must be shown
  - hideLegend
```
void hideLegend(FLayer lyr)
```
    Makes layer legend details not visible
    
    Parameters:
    
    lyr - layer whose legend details must be hidden
  - selectLayer
```
void selectLayer(FLayer lyr)
```
    Add a layer to the set of selected layers
    
    Parameters:
    
    lyr - layer which must be selected (not exclusively)
  - unselectLayer
```
void unselectLayer(FLayer lyr)
```
    Removes a layer from the set of selected layers
    
    Parameters:
    
    lyr - layer which must be unselected
  - clearSelection
```
void clearSelection()
```
    Clears current layer selection
  - getSelectedLayers
```
FLayer[] getSelectedLayers()
```
    Returns:
    
    array of selected layers
  - setActiveLayer
```
void setActiveLayer(FLayer lyr)
```
    Sets a layer as active (exclusively: the number of active layers must be 0 or 1)
    
    Parameters:
    
    lyr - layer to be set as active or null to have 0 layers active
  - getActiveLayer
```
FLayer getActiveLayer()
```
    Returns:
    
    the currently active layer or null if no layer is active
  - invokeAction
```
void invokeAction(FLayer lyr,
                  String action)
```
    Invokes a certain action on a certain layer
    
    Parameters:
    
    lyr - the layer on which the action will be performed
    
    action - the action to be performed
  - addLegendActionListener
```
void addLegendActionListener(LegendActionEventListener lel)
```
    Adds a legend action listener. These listeners will be notified when the user shows interest in a legend symbol (typically double click)
    
    Parameters:
    
    lel - new legend action listener
  - removeLegendActionListener
```
void removeLegendActionListener(LegendActionEventListener lel)
```
    Removes a legend action listener
    
    Parameters:
    
    lel - legend action listener to be removed
  - addLayerActionListener
```
void addLayerActionListener(LayerActionEventListener lel)
```
    Adds a layer action listener. These listeners will be notified when the user shows interest in a layer (typically double click)
    
    Parameters:
    
    lel - new layer action listener
  - removeLayerActionListener
```
void removeLayerActionListener(LayerActionEventListener lel)
```
    Removes a layer action listener
    
    Parameters:
    
    lel - layer action listener to be removed
  - addActiveLayerChangeListener
```
void addActiveLayerChangeListener(ActiveLayerChangeEventListener alcel)
```
    Adds a active layer change listener. These listeners will be notified when a new layer is set as active
    
    Parameters:
    
    alcel - new active layer change listener
  - removeActiveLayerChangeListener
```
void removeActiveLayerChangeListener(ActiveLayerChangeEventListener alcel)
```
    Removes a active layer change listener
    
    Parameters:
    
    alcel - active layer change listener to be removed

Interface TOC

Method Summary

Methods inherited from interface org.gvsig.tools.service.Service

Method Detail

getParameters

getFactory

getComponent

getMapContext

showAll

hideAll

showAllLegends

hideAllLegends

show

showLegend

hideLegend

selectLayer

unselectLayer

clearSelection

getSelectedLayers

setActiveLayer

getActiveLayer

invokeAction

addLegendActionListener

removeLegendActionListener

addLayerActionListener

removeLayerActionListener

addActiveLayerChangeListener

removeActiveLayerChangeListener