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

Interface ILabelingMethod

All Superinterfaces:

org.gvsig.tools.persistence.Persistent

public interface ILabelingMethod
extends org.gvsig.tools.persistence.Persistent

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

Author:

jaume dominguez faus - jaume.dominguez@iver.es

Method Summary

Methods

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.
org.gvsig.fmap.dal.feature.FeatureSet	getFeatureIteratorByLabelClass(FLyrVect layer, ILabelClass lc, ViewPort viewPort, java.lang.String[] usedFields)
ILabelClass	getLabelClassByName(java.lang.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, java.lang.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

addLabelClass

void addLabelClass(ILabelClass lbl)

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

Parameters:

lbl -

allowsMultipleClass

boolean allowsMultipleClass()

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

Returns:

boolean

clearAllClasses

void clearAllClasses()

cloneMethod

ILabelingMethod cloneMethod()

definesPriorities

boolean definesPriorities()

deleteLabelClass

void deleteLabelClass(ILabelClass lbl)

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

Parameters:

lbl, - the LabelClass to be removed

getFeatureIteratorByLabelClass

org.gvsig.fmap.dal.feature.FeatureSet getFeatureIteratorByLabelClass(FLyrVect layer,
                                                                   ILabelClass lc,
                                                                   ViewPort viewPort,
                                                                   java.lang.String[] usedFields)
                                                                     throws org.gvsig.fmap.dal.exception.DataException

Parameters:

layer -

lc -

viewPort -

usedFields -

Returns:

Throws:

org.gvsig.fmap.dal.exception.DataException

getLabelClassByName

ILabelClass getLabelClassByName(java.lang.String labelName)

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

Parameters:

labelName -

Returns:

getLabelClasses

ILabelClass[] getLabelClasses()

Returns all the labels defined by this Labeling Method

Returns:

all the labels in this labeling method;

renameLabelClass

void renameLabelClass(ILabelClass lbl,
                    java.lang.String newName)

Changes the mane of a given LabelClass

Parameters:

lbl, - the LabelClass

newName, - the new name

setDefinesPriorities

void setDefinesPriorities(boolean flag)