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
Modifier and TypeMethodDescriptionvoidaddLabelClass(ILabelClass lbl) Adds a LabelClass to the set of LabelClass contained by this ILabelingMethod.booleanReturns true if this ILabelingMethod allos the definition of more LabelClasses than just the default LabelClass.voidbooleanvoidRemoves the LabelClass from the set of LabelClasses contained by this ILabelingMethod.org.gvsig.fmap.dal.feature.FeatureSetgetFeatureIteratorByLabelClass(FLyrVect layer, ILabelClass lc, ViewPort viewPort, String[] usedFields) getLabelClassByName(String labelName) Returns the LabelClass contained by this ILabelingMethod whose name matches with the string passed in labelName.Returns all the labels defined by this Labeling MethodvoidrenameLabelClass(ILabelClass lbl, String newName) Changes the mane of a given LabelClassvoidsetDefinesPriorities(boolean flag) Methods inherited from interface org.gvsig.tools.persistence.Persistent
loadFromState, saveToState
-
Method Details
-
getLabelClasses
ILabelClass[] getLabelClasses()Returns all the labels defined by this Labeling Method- Returns:
- all the labels in this labeling method;
-
getLabelClassByName
Returns the LabelClass contained by this ILabelingMethod whose name matches with the string passed in labelName.- Parameters:
labelName-- Returns:
-
addLabelClass
Adds a LabelClass to the set of LabelClass contained by this ILabelingMethod.- Parameters:
lbl-
-
deleteLabelClass
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
Changes the mane of a given LabelClass- Parameters:
lbl- , the LabelClassnewName- , the new name
-
getFeatureIteratorByLabelClass
org.gvsig.fmap.dal.feature.FeatureSet getFeatureIteratorByLabelClass(FLyrVect layer, ILabelClass lc, ViewPort viewPort, String[] usedFields) throws org.gvsig.fmap.dal.exception.DataException - Parameters:
layer-lc-viewPort-usedFields-- Returns:
- Throws:
org.gvsig.fmap.dal.exception.DataException
-
definesPriorities
boolean definesPriorities() -
setDefinesPriorities
void setDefinesPriorities(boolean flag) -
clearAllClasses
void clearAllClasses() -
cloneMethod
ILabelingMethod cloneMethod()
-