| org.geotools.renderer.lite.LabelCache
All known Subclasses: org.geotools.renderer.shape.IntegratingLabelCache, org.geotools.renderer.lite.SynchronizedLabelCache, org.geotools.renderer.lite.LabelCacheDefault,
| LabelCache | | public interface LabelCache (Code) | | An interface for a label cache.
author:
jeichar
since:
0.9.0 |
| Method Summary | |
| public void | clear()
| | public void | clear(String layerId)
Clears the cache of all information relating to the layer identified. | | public void | disableLayer(String layerId)
Leaves the label information in the cache but ignores it when calculating what labels are drawn. | | public void | enableLayer(String layerId)
Enable a layer after being disabled. | | void | end(Graphics2D graphics, Rectangle displayArea)
Called to indicate that the map is done rendering. | | void | endLayer(String layerId, Graphics2D graphics, Rectangle displayArea)
Called to indicate that a layer is done rendering. | | public List | orderedLabels()
return a list with all the values in priority order. | | void | put(String layerId, TextSymbolizer symbolizer, Feature feature, LiteShape2 shape, Range scaleRange)
Puts a Label in the cache.
Parameters:
layerId - id indicating the layer the feature is part of
Parameters:
symbolizer - The symbolizer containing the style information
Parameters:
feature - the feature that has the information required for the symbolizer to calculate the required render information. | | void | start()
Called by renderer to indicate that the rendering process is starting. | | void | startLayer(String layerId)
Called by renderer to indication the start of rendering a layer. | | void | stop()
Tells the cache to stop labelling. |
| clear | | public void clear()(Code) | | Clears the cache completely
|
| clear | | public void clear(String layerId)(Code) | | Clears the cache of all information relating to the layer identified.
Parameters:
layerId - id of the layer |
| disableLayer | | public void disableLayer(String layerId)(Code) | | Leaves the label information in the cache but ignores it when calculating what labels are drawn.
Parameters:
layerId - id of the layer to disable. |
| enableLayer | | public void enableLayer(String layerId)(Code) | | Enable a layer after being disabled. If startLayer is called this does not need to be called
as start layer implicitely activates the layer.
Parameters:
layerId - layer to activate. |
| end | | void end(Graphics2D graphics, Rectangle displayArea)(Code) | | Called to indicate that the map is done rendering. The method may draw labels if appropriate
for the labeling algorithm
Parameters:
graphics - the graphics to draw on.
Parameters:
displayArea - The size of the display area. |
| endLayer | | void endLayer(String layerId, Graphics2D graphics, Rectangle displayArea)(Code) | | Called to indicate that a layer is done rendering. The method may draw labels if appropriate
for the labeling algorithm
Parameters:
graphics - the graphics to draw on.
Parameters:
displayArea - The size of the display area
Parameters:
layerId - an id for the layer |
| orderedLabels | | public List orderedLabels()(Code) | | return a list with all the values in priority order. Both grouped and non-grouped
Parameters:
labelCache - |
| put | | void put(String layerId, TextSymbolizer symbolizer, Feature feature, LiteShape2 shape, Range scaleRange)(Code) | | Puts a Label in the cache.
Parameters:
layerId - id indicating the layer the feature is part of
Parameters:
symbolizer - The symbolizer containing the style information
Parameters:
feature - the feature that has the information required for the symbolizer to calculate the required render information.
Parameters:
shape - the shape to be labeled. This is in screen coordinates.
Parameters:
scaleRange - the scaleRange that the symbolizer is legal |
| start | | void start()(Code) | | Called by renderer to indicate that the rendering process is starting.
|
| startLayer | | void startLayer(String layerId)(Code) | | Called by renderer to indication the start of rendering a layer. Will add the layer to the
set of active layers.
Parameters:
layerId - an id for the layer |
| stop | | void stop()(Code) | | Tells the cache to stop labelling.
|
|
|