public interface IlvMapLabeler extends IlvPersistentObject
IlvMapLabeler
must implement.
A labeler is responsible for labeling a map. Labels are usually drawn on the map
retrieving values from IlvAttribute
attached to graphic object.
A default implementation of the IlvMapLabeler
is IlvMapDefaultLabeler
.Modifier and Type | Method and Description |
---|---|
void |
addLayer(IlvMapLayer layer)
Add a layer to be labeled by this labeler.
|
IlvMapLabelingLabel[] |
createLabels(IlvGraphic graphic,
String message)
Creates and sets up map label components.
|
IlvMapLayer |
getLabeledLayer(IlvMapLayer labelLayer)
Retrieves the
IlvMapLayer for which this label layer has been created. |
IlvMapLayer |
getLabelLayer()
Deprecated.
|
IlvMapLayer |
getLabelLayer(IlvMapLayer layer)
Retrieves the
IlvMapLayer on which labels are drawn for this specific map layer. |
Iterator |
getLabelLayers()
Returns The list of the label layers.
|
IlvMapLabelManager |
getLabelManager()
Retrieves the internal
IlvMapLabelManager instance used to create labels. |
IlvManagerView |
getView()
Retrieves the view associated to this labeler.
|
void |
labelize()
Deprecated.
Use #performLabeling().
|
void |
performLabeling()
Performs the labeling.
|
void |
removeLayer(IlvMapLayer layer)
Removes a layer from this labeler.
|
void |
setLabelLayer(IlvMapLayer layer)
Sets the label layer.
|
void |
setView(IlvManagerView view)
Sets the view to the labeler.
|
write
void setView(IlvManagerView view)
view
- The view to add.IlvManagerView getView()
void addLayer(IlvMapLayer layer)
layer
- A new layer to be labeled.void removeLayer(IlvMapLayer layer)
layer
- The layer to remove.IlvMapLayer getLabelLayer(IlvMapLayer layer)
IlvMapLayer
on which labels are drawn for this specific map layer.layer
- the layer to retrieve label layer for.IlvMapLayer
IlvMapLayer getLabeledLayer(IlvMapLayer labelLayer)
IlvMapLayer
for which this label layer has been created.labelLayer
- The label layer for which you want to retrieve the source layer.IlvMapLayer
.IlvMapLabelManager getLabelManager()
IlvMapLabelManager
instance used to create labels.IlvMapLayer
.IlvMapLayer getLabelLayer()
IlvMapLayer
on which labels are drawn.
use getLabelLayer(IlvMapLayer)
instead.IlvMapLayer
IlvMapLabelingLabel[] createLabels(IlvGraphic graphic, String message)
IlvGraphicSet
can have more than
one label component.
This utility method is typically used in
IlvMapLabelFactory.getGisLabel(IlvGraphic)
.graphic
- The graphic object for which one or more labels should
be created.message
- A String
containing the label message.void setLabelLayer(IlvMapLayer layer)
layer
- The new label layer.void labelize()
void performLabeling()
Iterator getLabelLayers()
© Copyright Rogue Wave Software, Inc. 1997, 2016. All Rights Reserved.