org.gvsig.fmap.mapcontext.layers.vectorial

Interface GraphicLayer

All Superinterfaces:

Classifiable, ClassifiableVectorial, org.gvsig.tools.dispose.Disposable, org.gvsig.tools.dynobject.DynObject, FLayer, ILabelable, InfoByPoint, org.gvsig.metadata.Metadata, org.gvsig.tools.persistence.Persistent, org.cresques.geo.Projected, SingleLayer, VectorLayer

All Known Implementing Classes:

DefaultGraphicLayer

public interface GraphicLayer
extends VectorLayer

Utility layer to be able to draw graphics in a MapContext. Those graphics won't be stored and will be rendered on top of all the other MapContext's layers.

Version:

$Id$

Author:

gvSIG team

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PRIORITY
static java.lang.String	FEATURE_ATTR_FEATUREID
static java.lang.String	FEATURE_ATTR_GEOMETRY
static java.lang.String	FEATURE_ATTR_GROUPID
static java.lang.String	FEATURE_ATTR_IDSYMBOL
static java.lang.String	FEATURE_ATTR_LABEL
static java.lang.String	FEATURE_ATTR_PRIORITY
static java.lang.String	FEATURE_ATTR_TAG

Fields inherited from interface org.gvsig.fmap.mapcontext.layers.FLayer

METADATA_CRS, METADATA_DEFINITION_DESCRIPTION, METADATA_DEFINITION_NAME, METADATA_NAME

Method Summary

Methods

Modifier and Type	Method and Description
void	addGraphic(java.lang.String groupId, org.gvsig.fmap.geom.Geometry geom, int idsym) Adds a new Geometry to be rendered into the layer.
void	addGraphic(java.lang.String groupId, org.gvsig.fmap.geom.Geometry geom, int idsym, java.lang.String label) Adds a new Geometry to be rendered into the layer.
void	addGraphic(java.lang.String groupId, org.gvsig.fmap.geom.Geometry geom, int idsym, java.lang.String label, java.lang.Object tag, int priority) Adds a new Geometry to be rendered into the layer.
void	addGraphics(java.lang.String groupId, java.util.Iterator geoms, int idsym) Adds a new Geometry to be rendered into the layer.
void	addGraphics(java.lang.String groupId, java.util.Iterator geoms, int idsym, java.lang.String label) Adds a new Geometry to be rendered into the layer.
void	addGraphics(java.lang.String groupId, java.util.Iterator geoms, int idsym, java.lang.String label, java.lang.Object tag, int priority) Adds a new Geometry to be rendered into the layer.
int	addSymbol(ISymbol newSymbol) Adds a new ISymbol to the layer to be used to render the Geometry objects.
void	clearAllGraphics() Removes all registered Geometry objects.
int	clearAllSymbols() Removes all registered ISymbol objects.
ISymbol	getSymbol(int symbolId) Returns the ISymbol of the layer with the given identifier.
int	getSymbolId(ISymbol symbol) Returns the identifier of the symbol into the layer.
void	removeGraphics(java.lang.String groupId) Removes all previously registered Geometry objects from the layer with the given groupId.

Methods inherited from interface org.gvsig.fmap.mapcontext.layers.vectorial.VectorLayer

getFeatureStore

Methods inherited from interface org.gvsig.fmap.mapcontext.layers.operations.SingleLayer

getDataStore

Methods inherited from interface org.gvsig.fmap.mapcontext.layers.FLayer

addError, addLayerListener, allowLinks, cloneLayer, draw, getCoordTrans, getDrawVersion, getError, getErrors, getExtendedProperties, getFLayerStatus, getFullEnvelope, getInfoString, getLayerListeners, getLink, getLinkProperties, getMapContext, getMaxScale, getMinScale, getName, getNumErrors, getParentLayer, getProperty, getTocImageIcon, getTocStatusImage, isActive, isAvailable, isEditing, isInTOC, isOk, isVisible, isWithinScale, isWritable, load, newComposedLayer, print, reload, removeLayerListener, setActive, setAvailable, setCoordTrans, setFLayerStatus, setInTOC, setMaxScale, setMinScale, setName, setParentLayer, setProjection, setProperty, setVisible, visibleRequired

Methods inherited from interface org.cresques.geo.Projected

getProjection, reProject

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

loadFromState, saveToState

Methods inherited from interface org.gvsig.metadata.Metadata

getMetadataChildren, getMetadataID, getMetadataName

Methods inherited from interface org.gvsig.tools.dynobject.DynObject

clear, delegate, getDynClass, getDynValue, hasDynValue, implement, invokeDynMethod, invokeDynMethod, setDynValue

Methods inherited from interface org.gvsig.tools.dispose.Disposable

dispose

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.styling.ILabelable

drawLabels, getLabelingStrategy, isLabeled, printLabels, setIsLabeled, setLabelingStrategy

Methods inherited from interface org.gvsig.fmap.mapcontext.layers.operations.InfoByPoint

getInfo

Methods inherited from interface org.gvsig.fmap.mapcontext.layers.operations.ClassifiableVectorial

setLegend

Methods inherited from interface org.gvsig.fmap.mapcontext.layers.operations.Classifiable

addLegendListener, getGeometryType, getLegend, removeLegendListener

Field Detail

DEFAULT_PRIORITY

static final int DEFAULT_PRIORITY

See Also:

Constant Field Values

FEATURE_ATTR_FEATUREID

static final java.lang.String FEATURE_ATTR_FEATUREID

See Also:

Constant Field Values

FEATURE_ATTR_GEOMETRY

static final java.lang.String FEATURE_ATTR_GEOMETRY

See Also:

Constant Field Values

FEATURE_ATTR_GROUPID

static final java.lang.String FEATURE_ATTR_GROUPID

See Also:

Constant Field Values

FEATURE_ATTR_IDSYMBOL

static final java.lang.String FEATURE_ATTR_IDSYMBOL

See Also:

Constant Field Values

FEATURE_ATTR_LABEL

static final java.lang.String FEATURE_ATTR_LABEL

See Also:

Constant Field Values

FEATURE_ATTR_PRIORITY

static final java.lang.String FEATURE_ATTR_PRIORITY

See Also:

Constant Field Values

FEATURE_ATTR_TAG

static final java.lang.String FEATURE_ATTR_TAG

See Also:

Constant Field Values

Method Detail

addGraphic

void addGraphic(java.lang.String groupId,
              org.gvsig.fmap.geom.Geometry geom,
              int idsym)

Adds a new Geometry to be rendered into the layer.

Parameters:

groupId - group identifier. Allows to identify a group of Geometry added to the layer

geom - the Geometry to add

idsym - the ISymbol identifier to apply to render the Geometry

addGraphic

void addGraphic(java.lang.String groupId,
              org.gvsig.fmap.geom.Geometry geom,
              int idsym,
              java.lang.String label)

Adds a new Geometry to be rendered into the layer.

Parameters:

groupId - group identifier. Allows to identify a group of Geometry added to the layer

geom - the Geometry to add

idsym - the ISymbol identifier to apply to render the Geometry

label - the text to show if the ISymbol is a ITextSymbol. Set null otherwise.

addGraphic

void addGraphic(java.lang.String groupId,
              org.gvsig.fmap.geom.Geometry geom,
              int idsym,
              java.lang.String label,
              java.lang.Object tag,
              int priority)

Adds a new Geometry to be rendered into the layer.

Parameters:

groupId - group identifier. Allows to identify a group of Geometry added to the layer

geom - the Geometry to add

idsym - the ISymbol identifier to apply to render the Geometry

label - the text to show if the ISymbol is a ITextSymbol. Set null otherwise.

tag - an object to classify, identify or add related information to the Geometry

priority - to apply while rendering the Geometry. Values with lower priority will be rendered first.

addGraphics

void addGraphics(java.lang.String groupId,
               java.util.Iterator geoms,
               int idsym)

Adds a new Geometry to be rendered into the layer.

Parameters:

groupId - group identifier. Allows to identify a group of Geometry added to the layer

geoms - the Geometrys to add

idsym - the ISymbol identifier to apply to render the Geometry

addGraphics

void addGraphics(java.lang.String groupId,
               java.util.Iterator geoms,
               int idsym,
               java.lang.String label)

Adds a new Geometry to be rendered into the layer.

Parameters:

groupId - group identifier. Allows to identify a group of Geometry added to the layer

geoms - the Geometrys to add

idsym - the ISymbol identifier to apply to render the Geometry

label - the text to show if the ISymbol is a ITextSymbol. Set null otherwise.

addGraphics

void addGraphics(java.lang.String groupId,
               java.util.Iterator geoms,
               int idsym,
               java.lang.String label,
               java.lang.Object tag,
               int priority)

Adds a new Geometry to be rendered into the layer.

Parameters:

groupId - group identifier. Allows to identify a group of Geometry added to the layer

geoms - the Geometrys to add

idsym - the ISymbol identifier to apply to render the Geometry

label - the text to show if the ISymbol is a ITextSymbol. Set null otherwise.

tag - an object to classify, identify or add related information to the Geometry

priority - to apply while rendering the Geometry. Values with lower priority will be rendered first.

addSymbol

int addSymbol(ISymbol newSymbol)

Adds a new ISymbol to the layer to be used to render the Geometry objects. The symbol will be added to the legend of the layer.

Parameters:

newSymbol - the ISymbol to add

Returns:

an identifier of the symbol to be used when adding geometries

clearAllGraphics

void clearAllGraphics()

Removes all registered Geometry objects.

clearAllSymbols

int clearAllSymbols()

Removes all registered ISymbol objects.

getSymbol

ISymbol getSymbol(int symbolId)

Returns the ISymbol of the layer with the given identifier.

Parameters:

symbolId - the symbol identifier

Returns:

the symbol with the given id or null if there is not any symbol registered with that id

getSymbolId

int getSymbolId(ISymbol symbol)

Returns the identifier of the symbol into the layer.

Parameters:

symbol - the symbol to look for

Returns:

the symbol identifier or -1 if it is not registered into the layer

removeGraphics

void removeGraphics(java.lang.String groupId)

Removes all previously registered Geometry objects from the layer with the given groupId.

Parameters:

groupId - of the geometries to remove