gistoolkit.display
Interface Labeler

All Known Implementing Classes:
SimpleLabeler

public interface Labeler

Labelers are responsible for labeling the features of a particular layer. They are part of the style of the layer, and can be replaced.


Method Summary
 void beginLabel()
          Called before the layer is initially labeled to allow the labeler to prepare for labeling.
 boolean drawLabel(Record inRecord, java.awt.Graphics inGraphics, Converter inConverter, Shader inShader)
          Draw the label for the record on the graphics context
 boolean drawLabelHighlight(Record inRecord, java.awt.Graphics inGraphics, Converter inConverter, Shader inShader)
          Highlight the Label when the shape is highlighted.
 void endLabel()
          Called after the layer has completed labeling.
 java.lang.String getLabelerName()
          Get a name for this labeler.
 Node getNode()
          get the configuration information for this labeler
 void setNode(Node inNode)
          Set the configuration information for this labeler
 

Method Detail

getLabelerName

public java.lang.String getLabelerName()
Get a name for this labeler.


beginLabel

public void beginLabel()
Called before the layer is initially labeled to allow the labeler to prepare for labeling.


endLabel

public void endLabel()
Called after the layer has completed labeling.


drawLabel

public boolean drawLabel(Record inRecord,
                         java.awt.Graphics inGraphics,
                         Converter inConverter,
                         Shader inShader)
Draw the label for the record on the graphics context


drawLabelHighlight

public boolean drawLabelHighlight(Record inRecord,
                                  java.awt.Graphics inGraphics,
                                  Converter inConverter,
                                  Shader inShader)
Highlight the Label when the shape is highlighted.


getNode

public Node getNode()
get the configuration information for this labeler


setNode

public void setNode(Node inNode)
             throws java.lang.Exception
Set the configuration information for this labeler

Throws:
java.lang.Exception