org.gvsig.fmap.mapcontext.rendering.legend.styling

Interface ILabelable

All Known Subinterfaces:

GraphicLayer, VectorLayer

All Known Implementing Classes:

DefaultGraphicLayer, FLyrVect, FLyrVect

public interface ILabelable

This interface enables support for labeling an object such as a layer, but also others, if any. It gives support for detecting if labeling is being applied (isLabeled() and setIsLabeled()), to manage the labeling strategy (getLabelingStrategy() and setLabelingStrategy). The labeling is performed by the drawLabels(..) method.

Method Summary

Modifier and Type	Method and Description
void	drawLabels(java.awt.image.BufferedImage image, java.awt.Graphics2D g, ViewPort viewPort, Cancellable cancel, double scale, double dpi) Causes the labels to be drawn.
ILabelingStrategy	getLabelingStrategy() Returns the current labeling strategy
boolean	isLabeled() Returns true if labels are drawn, or false otherwise.
void	printLabels(java.awt.Graphics2D g, ViewPort viewPort, Cancellable cancel, double scale, PrintAttributes properties)
void	setIsLabeled(boolean isLabeled) Enables or disables the label drawing.
void	setLabelingStrategy(ILabelingStrategy strategy) Sets the new labeling strategy.

Method Detail

isLabeled

boolean isLabeled()

Returns true if labels are drawn, or false otherwise.

Returns:

boolean telling if labels are drawn

setIsLabeled

void setIsLabeled(boolean isLabeled)

Enables or disables the label drawing.

Parameters:

isLabeled, - if true then labels will be drawn

getLabelingStrategy

ILabelingStrategy getLabelingStrategy()

Returns the current labeling strategy

Returns:

ILabelingStrategy

See Also:

ILabelingStrategy

setLabelingStrategy

void setLabelingStrategy(ILabelingStrategy strategy)

Sets the new labeling strategy. Changes on the results will take effect next time the drawLabels(...) method is invoked.

Parameters:

strategy -

drawLabels

void drawLabels(java.awt.image.BufferedImage image,
                java.awt.Graphics2D g,
                ViewPort viewPort,
                Cancellable cancel,
                double scale,
                double dpi)
         throws ReadException

Causes the labels to be drawn. The policy of process is determined by the LabelingStrategy previously set.

Parameters:

image -

g -

viewPort -

cancel -

scale -

dpi -

Throws:

ReadException

printLabels

void printLabels(java.awt.Graphics2D g,
                 ViewPort viewPort,
                 Cancellable cancel,
                 double scale,
                 PrintAttributes properties)
          throws ReadException

Throws:

ReadException