org.gvsig.labeling.label

Class OnSelectionLabeled

java.lang.Object

org.gvsig.labeling.label.OnSelectionLabeled

All Implemented Interfaces:

ILabelingMethod, Persistent

public class OnSelectionLabeled
extends Object
implements ILabelingMethod

OnSelectionLabeled.java

Constructor Summary

Constructors

Constructor and Description
OnSelectionLabeled() Empty constructor for persistence.
OnSelectionLabeled(ILabelClass defaultLabel)

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	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
static void	registerPersistent()
void	renameLabelClass(ILabelClass lbl, String newName) Changes the mane of a given LabelClass
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setDefinesPriorities(boolean flag)

Methods inherited from class java.lang.Object

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

Constructor Detail

OnSelectionLabeled

public OnSelectionLabeled()

Empty constructor for persistence.

OnSelectionLabeled

public OnSelectionLabeled(ILabelClass defaultLabel)

Method Detail

addLabelClass

public void addLabelClass(ILabelClass lbl)

Description copied from interface: ILabelingMethod

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

Specified by:

addLabelClass in interface ILabelingMethod

deleteLabelClass

public void deleteLabelClass(ILabelClass lbl)

Description copied from interface: ILabelingMethod

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

Specified by:

deleteLabelClass in interface ILabelingMethod

allowsMultipleClass

public boolean allowsMultipleClass()

Description copied from interface: ILabelingMethod

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

Specified by:

allowsMultipleClass in interface ILabelingMethod

Returns:

boolean

renameLabelClass

public void renameLabelClass(ILabelClass lbl,
                             String newName)

Description copied from interface: ILabelingMethod

Changes the mane of a given LabelClass

Specified by:

renameLabelClass in interface ILabelingMethod

getFeatureIteratorByLabelClass

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

Specified by:

getFeatureIteratorByLabelClass in interface ILabelingMethod

Returns:

Throws:

DataException

definesPriorities

public boolean definesPriorities()

Specified by:

definesPriorities in interface ILabelingMethod

setDefinesPriorities

public void setDefinesPriorities(boolean flag)

Specified by:

setDefinesPriorities in interface ILabelingMethod

getLabelClassByName

public ILabelClass getLabelClassByName(String labelName)

Description copied from interface: ILabelingMethod

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

Specified by:

getLabelClassByName in interface ILabelingMethod

Returns:

clearAllClasses

public void clearAllClasses()

Specified by:

clearAllClasses in interface ILabelingMethod

getLabelClasses

public ILabelClass[] getLabelClasses()

Description copied from interface: ILabelingMethod

Returns all the labels defined by this Labeling Method

Specified by:

getLabelClasses in interface ILabelingMethod

Returns:

all the labels in this labeling method;

cloneMethod

public ILabelingMethod cloneMethod()

Specified by:

cloneMethod in interface ILabelingMethod

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Description copied from interface: Persistent

Set the state of the object from the state passed as parameter.

Specified by:

loadFromState in interface Persistent

Throws:

PersistenceException

saveToState

public void saveToState(PersistentState state)
                 throws PersistenceException

Description copied from interface: Persistent

Saves the internal state of the object on the provided PersistentState object.

Specified by:

saveToState in interface Persistent

Throws:

PersistenceException

registerPersistent

public static void registerPersistent()