gistoolkit.display.labeler
Class MultipleLabeler

java.lang.Object
  extended bygistoolkit.display.labeler.SimpleLabeler
      extended bygistoolkit.display.labeler.MultipleLabeler
All Implemented Interfaces:
Labeler

public class MultipleLabeler
extends SimpleLabeler

Class for labeling an object with multiple attribute columns.


Field Summary
 
Fields inherited from class gistoolkit.display.labeler.SimpleLabeler
CENTER, EAST, NORTH, SOUTH, WEST
 
Constructor Summary
MultipleLabeler()
          Creates a new instance of MultipleLabeler
 
Method Summary
 void addLabelColumn(int inLabelColumn)
          Add the number of the column to label by.
 void addLabelColumn(int inColumnNum, int inColumnFormat, java.lang.String inColumnPreString, java.lang.String inColumnPostString)
          Add the number of the column, and it's attributes.
 void beginLabel()
          Called before the layer is initially labeled to allow the labeler to prepare for labeling.
 void clearLabelColumns()
          Clear all the label columns.
static java.lang.String decodeString(java.lang.String inString)
          Decode the carage returns so they can be displayed.
protected  boolean drawLabel(Record inRecord, java.awt.Graphics inGraphics, Converter inConverter)
          Draw the label for the record on the graphics context
static java.lang.String encodeString(java.lang.String inString)
          encode the carage returns in a different string form for storage.
 void endLabel()
          Called after the layer has completed labeling.
 int getCountLabelColumns()
          Get the number of label columns.
 java.lang.String getDelimiter()
          Get the string to place between the labels.
 LabelerPanel getEditPanel()
          Return the edit panel used to edit this labeler
 ColumnAttributes getLabelAttributes(int inIndex)
          Return the information for the label columns.
 java.lang.String getLabelerName()
          A name for this labeler, returns "Simple Labeler".
 Node getNode()
          get the configuration information for this labeler
 void setDelimiter(java.lang.String inString)
          Set the string to place between the labels.
 void setNode(Node inNode)
          Set the configuration information for this labeler
 
Methods inherited from class gistoolkit.display.labeler.SimpleLabeler
drawLabel, drawLabelHighlight, drawString, getAllowDuplicates, getAllowOverlaps, getBounds, getLabelColumn, getLabelOffset, getLabelOrientation, getLabelPosition, getOverlapManager, getStrings, isDuplicate, isOverLaps, isOverLaps, removeDuplicate, setAllowDuplicates, setAllowOverlaps, setLabelColumn, setLabelOffset, setLabelOrientation, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MultipleLabeler

public MultipleLabeler()
Creates a new instance of MultipleLabeler

Method Detail

getDelimiter

public java.lang.String getDelimiter()
Get the string to place between the labels.


setDelimiter

public void setDelimiter(java.lang.String inString)
Set the string to place between the labels.


getLabelerName

public java.lang.String getLabelerName()
A name for this labeler, returns "Simple Labeler".

Specified by:
getLabelerName in interface Labeler
Specified by:
getLabelerName in class SimpleLabeler

addLabelColumn

public void addLabelColumn(int inLabelColumn)
Add the number of the column to label by.


addLabelColumn

public void addLabelColumn(int inColumnNum,
                           int inColumnFormat,
                           java.lang.String inColumnPreString,
                           java.lang.String inColumnPostString)
Add the number of the column, and it's attributes.


getCountLabelColumns

public int getCountLabelColumns()
Get the number of label columns.


getLabelAttributes

public ColumnAttributes getLabelAttributes(int inIndex)
Return the information for the label columns.


clearLabelColumns

public void clearLabelColumns()
Clear all the label columns.


drawLabel

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

Specified by:
drawLabel in class SimpleLabeler

getEditPanel

public LabelerPanel getEditPanel()
Return the edit panel used to edit this labeler


getNode

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

Specified by:
getNode in interface Labeler
Overrides:
getNode in class SimpleLabeler

setNode

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

Specified by:
setNode in interface Labeler
Overrides:
setNode in class SimpleLabeler
Throws:
java.lang.Exception

beginLabel

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

Specified by:
beginLabel in interface Labeler
Overrides:
beginLabel in class SimpleLabeler

endLabel

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

Specified by:
endLabel in interface Labeler
Overrides:
endLabel in class SimpleLabeler

encodeString

public static java.lang.String encodeString(java.lang.String inString)
encode the carage returns in a different string form for storage.


decodeString

public static java.lang.String decodeString(java.lang.String inString)
Decode the carage returns so they can be displayed.