Package noaa.coastwatch.render.lines

Class EdgeLabelFactory

java.lang.Object

noaa.coastwatch.render.lines.EdgeLabelFactory

All Implemented Interfaces:

LineLabelFactory

public class EdgeLabelFactory
extends Object
implements LineLabelFactory

The EdgeLabelFactory class creates labels that line up along the view edges.

Since:

3.3.1

Author:

Peter Hollemans

Method Summary

Modifier and Type	Method	Description
List<TextElement>	create(List<Line2D> segments, String text, Dimension imageDims)	Creates a set of line labels.
static EdgeLabelFactory	getInstance()	Gets the singleton instance of this class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getInstance

public static EdgeLabelFactory getInstance()

Gets the singleton instance of this class.

create

public List<TextElement> create(List<Line2D> segments,
 String text,
 Dimension imageDims)

Description copied from interface: LineLabelFactory

Creates a set of line labels.

Specified by:

create in interface LineLabelFactory

Parameters:

segments - the line segments for the line to label.

text - the label for the line.

imageDims - the image dimensions for the box whose edges contain the entire line and all its segments. This would typically be the view.

Returns:

the set of labels created by the factory, or null if no segments are inside the image boundaries.