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

Interface ILabelingMethod

All Superinterfaces:

Persistent

All Known Implementing Classes:

DefaultLabelingMethod, FeatureDependentLabeled, OnSelectionLabeled

public interface ILabelingMethod
extends Persistent

Interface that defines provides support to a ILabelingStrategy to supply the set of LabelClass(es) that handle the label's style, content, etc..

Method Summary

Modifier and Type	Method and Description
void	addLabelClass(ILabelClass lbl) Adds a LabelClass to the set of LabelClass contained by this ILabelingMethod.
boolean	allowsMultipleClass() Returns true if this ILabelingMethod allos the definition of more LabelClasses than just the default LabelClass.
void	clearAllClasses()
ILabelingMethod	cloneMethod()
boolean	definesPriorities()
void	deleteLabelClass(ILabelClass lbl) Removes the LabelClass from the set of LabelClasses contained by this ILabelingMethod.
FeatureSet	getFeatureIteratorByLabelClass(FLyrVect layer, ILabelClass lc, ViewPort viewPort, String[] usedFields)
ILabelClass	getLabelClassByName(String labelName) Returns the LabelClass contained by this ILabelingMethod whose name matches with the string passed in labelName.
ILabelClass[]	getLabelClasses() Returns all the labels defined by this Labeling Method
void	renameLabelClass(ILabelClass lbl, String newName) Changes the mane of a given LabelClass
void	setDefinesPriorities(boolean flag)

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

Method Detail

getLabelClasses

ILabelClass[] getLabelClasses()

Returns all the labels defined by this Labeling Method

Returns:

all the labels in this labeling method;

getLabelClassByName

ILabelClass getLabelClassByName(String labelName)

Returns the LabelClass contained by this ILabelingMethod whose name matches with the string passed in labelName.

Parameters:

labelName -

Returns:

addLabelClass

void addLabelClass(ILabelClass lbl)

Adds a LabelClass to the set of LabelClass contained by this ILabelingMethod.

Parameters:

lbl -

deleteLabelClass

void deleteLabelClass(ILabelClass lbl)

Removes the LabelClass from the set of LabelClasses contained by this ILabelingMethod.

Parameters:

lbl, - the LabelClass to be removed

allowsMultipleClass

boolean allowsMultipleClass()

Returns true if this ILabelingMethod allos the definition of more LabelClasses than just the default LabelClass.

Returns:

boolean

renameLabelClass

void renameLabelClass(ILabelClass lbl,
                      String newName)

Changes the mane of a given LabelClass

Parameters:

lbl, - the LabelClass

newName, - the new name

getFeatureIteratorByLabelClass

FeatureSet getFeatureIteratorByLabelClass(FLyrVect layer,
                                          ILabelClass lc,
                                          ViewPort viewPort,
                                          String[] usedFields)
                                   throws DataException

Parameters:

layer -

lc -

viewPort -

usedFields -

Returns:

Throws:

DataException

definesPriorities

boolean definesPriorities()

setDefinesPriorities

void setDefinesPriorities(boolean flag)

clearAllClasses

void clearAllClasses()

cloneMethod

ILabelingMethod cloneMethod()