MapContext

java.lang.Object
- org.gvsig.tools.dispose.impl.AbstractDisposable
- - org.gvsig.fmap.mapcontext.MapContext

All Implemented Interfaces:

java.lang.Iterable<FLayer>, Projected, Disposable, Observer, Persistent

Direct Known Subclasses:

MapContext
```
public class MapContext
extends AbstractDisposable
implements Projected, Persistent, Observer, java.lang.Iterable<FLayer>
```
The MapContext class represents the model and a part of the control and view around graphical layers used by MapControl.

An instance of MapContext is made up with:
- a hierarchy of FLayers nodes
- a GraphicLayer layer
- a ViewPort
- an EventButter
- some LegendListeners
- some LayerDrawingListeners
- some ErrorListeners

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`MapContext.LayerEventListener` The class `LayerEventListener` implements the methods of `LayerCollectionListener` that handles the "layer added" or "layer removed" events in a map.
`static interface`	`MapContext.MapTimeContext`
`static class`	`MapContext.RegisterPersistence`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.ArrayList`	`AREAABBR`
`static java.util.ArrayList`	`AREANAMES`
`static java.util.ArrayList`	`AREATRANS2METER`
`static double[]`	`CHANGE` Deprecated. use getDistanceTrans2Meter() * 100
`static double[]`	`CHANGEM` Deprecated. use getDistanceTrans2Meter()
`static int`	`CONTAINS`
`static int`	`CROSSES`
`static java.awt.Color`	`DEFAULT_SELECTION_COLOR`
`static int`	`DISJOINT`
`static java.util.ArrayList`	`DISTANCEABBR`
`static java.util.ArrayList`	`DISTANCENAMES`
`static java.util.ArrayList`	`DISTANCETRANS2METER`
`static int`	`EQUALS`
`static int`	`INTERSECTS`
`protected FLayers`	`layers` A hierarchy of `FLayers` nodes.
`static int`	`OVERLAPS`
`static int`	`TOUCHES`
`static int`	`WITHIN`
`static double`	`ZOOMINFACTOR` Default zoom in factor.
`static double`	`ZOOMOUTFACTOR` Default zoom out factor.

Constructor Summary

Constructors
Constructor and Description
`MapContext()`
`MapContext(FLayers fLayers, ViewPort vp)` Creates a new map context with the layers and the drawing information defined in the view port arguments.
`MapContext(ViewPort vp)` Creates a new map context with the drawing information defined in the view port argument, and without layers.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`addAreaUnit(java.lang.String name, java.lang.String abbr, boolean isLinear, double trans2meter)`
`void`	`addAsCollectionListener(FLayers layers2)` Adds the `LayerEventListener` of this map to the collection of layers argument.
`boolean`	`addAtomicEventListener(AtomicEventListener listener)` Adds a listener of atomic events to the internal `EventBuffer`.
`static void`	`addDistanceUnit(java.lang.String name, java.lang.String abbr, double trans2meter)`
`void`	`addErrorListener(ErrorListener listener)` Adds the specified error listener to receive error events from this map.
`void`	`addLayerDrawingListener(LayerDrawingListener listener)` Adds the specified layer drawing listener to catch and handle drawing events from layers of this map.
`void`	`addLayerError(java.lang.String stringProperty)` Registers the message of an error associated to this map.
`void`	`addLayerListener(LegendListener listener)` Deprecated. use addLegendListener
`void`	`addLegendListener(LegendListener listener)` Adds the specified legend listener (if didn't exist) to receive legend events from this map.
`void`	`addSelectionListener(FLayer lyr)` Registers an event buffer as a listener for all layers as argument.
`void`	`addToTrackLayer(FLayer vectorial)` Adds a layer to the group of layers that are at a upper level in the tree.
`void`	`beginAtomicEvent()`
`void`	`callLegendChanged()` Notifies to all legend listeners registered, that one legend has changed.
`void`	`callNewErrorEvent(ErrorEvent e)` Notifies to all error listeners registered, that one error has been produced.
`void`	`clearErrors()` Removes all error messages associated to this map.
`MapContext`	`cloneFMap()` Creates a new independent `MapContext` instance, that has a clone of the layers and the view port of this one.
`MapContext`	`cloneToDraw()` Like cloneFMap(), but now doesn't clone the layers, rather copies them.
`void`	`createIndex()`
`MapContext`	`createNewFMap(ViewPort vp)` Returns a new `MapContext` instance with the information of the `vp` argument, and the layers of this map.
`java.util.Iterator`	`deepiterator()`
`protected void`	`doDispose()` Internal implementation for the `AbstractDisposable.dispose()` method, to be implemented by child classes.
`void`	`draw(java.awt.image.BufferedImage image, java.awt.Graphics2D g, Cancellable cancel, double scale)` Draws this map if its `ViewPort` has an extent defined: Selects only the layers that have to be drawn: #prepareDrawing(BufferedImage, Graphics2D, double).
`void`	`draw(java.awt.image.BufferedImage image, java.awt.Graphics2D g, double scale)` Like draw(BufferedImage, Graphics2D, Cancellable, double) , but creating the task as cancellable.
`void`	`drawGraphics(java.awt.image.BufferedImage image, java.awt.Graphics2D g, Cancellable cancel, double scale)` Deprecated. use `draw(BufferedImage, Graphics2D, Cancellable, double)` instead
`void`	`drawLabels(java.awt.image.BufferedImage b)` Draws the visible layers of this map according its view port, on the image parameter.
`void`	`endAtomicEvent()`
`boolean`	`equals(java.lang.Object arg0)` Indicates whether some other object is "equal to" this map.
`void`	`fireLayerDrawingEvent(LayerDrawEvent e)` Fires a layer drawing event to all `LayerDrawingListener` listeners registered, distinguishing the kind of event.
`static java.lang.String[]`	`getAreaAbbr()`
`static java.lang.String[]`	`getAreaNames()`
`static double[]`	`getAreaTrans2Meter()`
`java.util.List`	`getAtomicEventListeners()`
`java.lang.String`	`getClassName()`
`static java.lang.String[]`	`getDistanceAbbr()`
`java.lang.String`	`getDistanceName()`
`static java.lang.String[]`	`getDistanceNames()`
`static int`	`getDistancePosition(java.lang.String s)`
`static double[]`	`getDistanceTrans2Meter()`
`static int`	`getDrawFrameRate()` Returns the draw frame rate.
`long`	`getDrawVersion()`
`java.util.List`	`getErrorListeners()`
`Envelope`	`getFullEnvelope()` Returns the union of all extents of all layers of this map.
`GraphicLayer`	`getGraphicsLayer()` Returns the internal `GraphicLayer`.
`VectorLayer`	`getGraphicsLayer(java.lang.String name)`
`java.util.Collection<VectorLayer>`	`getGraphicsLayers()`
`java.util.List`	`getLayerDrawingListeners()`
`FLayers`	`getLayers()` Returns the hierarchy of `FLayers` nodes stored in this map.
`java.util.ArrayList`	`getLayersError()` Gets the list with all error messages registered to this map.
`java.util.Set<FLyrVect>`	`getLayersToSnap()`
`java.util.List`	`getLegendListeners()`
`MapContextDrawer`	`getMapContextDrawer()`
`FLayers`	`getNewGroupLayer(FLayers parent)` Creates and returns a new group of layers that belongs to this `MapContext`.
`static java.lang.String`	`getOfLinear(int i)`
`LayerOrderManager`	`getOrderManager()`
`IProjection`	`getProjection()` Returns the current projection.
`long`	`getScaleToUseWhenEnvelopeCollapse()`
`double`	`getScaleView()` Returns the scale of the view in the screen.
`static double`	`getScreenDPI()` Returns the screen resolution (Dots Per Inch) as it was defined by the user's preference, or by default as it is defined in the default Toolkit.
`Envelope`	`getSelectionBounds()`
`java.awt.Color`	`getSelectionColor()` Gets the color used to represent the selections.
`MapContext.MapTimeContext`	`getTimeContext()`
`ViewPort`	`getViewPort()` Gets the `ViewPort` associated to this map.
`boolean`	`hasActiveLayers()`
`boolean`	`hasActiveVectorLayers()`
`boolean`	`hasLayers()`
`boolean`	`hasVectorLayers()`
`void`	`invalidate()`
`boolean`	`isPrintGraphicsLayer()`
`java.util.Iterator<FLayer>`	`iterator()`
`void`	`loadFromState(PersistentState state)` Set the state of the object from the state passed as parameter.
`void`	`print(java.awt.Graphics2D g, double scale, PrintAttributes properties)` Prints the layers of this map using the `Graphics2D` argument, that usually is the `Graphics` of the printer.
`void`	`process(Visitor visitor)`
`void`	`processSelected(Visitor visitor)`
`boolean`	`removeAtomicEventListener(AtomicEventListener listener)` Removes a listener of atomic events from the internal `EventBuffer`.
`void`	`removeErrorListener(LegendListener listener)` Removes the specified error listener from this map.
`void`	`removeGraphicsLayer(java.lang.String name)`
`void`	`removeLayerDrawListener(LayerDrawingListener listener)` Removes the specified layer drawing listener from this map.
`void`	`removeLayerListener(LegendListener listener)` Removes the specified layer listener from this map.
`void`	`reportDriverExceptions(java.lang.String introductoryText, java.util.List driverExceptions)` Reports to all driver error listeners registered of a bundle of driver exceptions caused in the same map atomic transaction.
`void`	`reProject(ICoordTrans arg0)` Changes projection of the graphical information of this object.
`void`	`saveToState(PersistentState state)` Saves the internal state of the object on the provided PersistentState object.
`void`	`select(Visitor visitor)`
`void`	`selectFromSelection()`
`static void`	`setDrawFrameRate(int theDrawFrameRate)` Sets the draw frame rate.
`void`	`setGraphicsLayer(GraphicLayer graphicLayer)` Sets a new `GraphicLayer` to this map.
`void`	`setGraphicsLayer(java.lang.String name, FLyrVect layer)`
`void`	`setLayersToSnap(java.util.Set<FLyrVect> layers)` Adds the layers to the current "layersToSnap" without replacing the current instance of "layersToSnap"
`void`	`setMapContextDrawer(MapContextDrawer drawer)`
`void`	`setMapContextDrawerClass(java.lang.Class mapContextDrawerClass)`
`void`	`setOrderManager(LayerOrderManager lom)`
`void`	`setPrintGraphicsLayer(boolean b)`
`void`	`setProjection(IProjection proj)` Sets the new projection.
`void`	`setScaleToUseWhenEnvelopeCollapse(long scale)`
`void`	`setScaleView(double scale)` Sets the new extent of the view, calculated using the scale argument.
`void`	`setSelectionColor(java.awt.Color selectionColor)` Sets the color used to represent the selections.
`void`	`setViewPort(ViewPort viewPort)` Sets a `ViewPort` with the drawing information of this map.
`void`	`update(Observable observable, java.lang.Object notification)` Called whenever a `Observable` object is changed and this `Observer` has registered on it to receive notifications.
`protected void`	`updateDrawVersion()`
`void`	`zoomToEnvelope(Envelope env)` Sets the given extent to the `ViewPort` and updates the view with the new zoom.

Methods inherited from class org.gvsig.tools.dispose.impl.AbstractDisposable
dispose, dispose

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - CHANGEM
```
public static final double[] CHANGEM
```
    Deprecated. use getDistanceTrans2Meter()
  - AREANAMES
```
public static java.util.ArrayList AREANAMES
```
  - AREAABBR
```
public static java.util.ArrayList AREAABBR
```
  - AREATRANS2METER
```
public static java.util.ArrayList AREATRANS2METER
```
  - DISTANCENAMES
```
public static java.util.ArrayList DISTANCENAMES
```
  - DISTANCEABBR
```
public static java.util.ArrayList DISTANCEABBR
```
  - DISTANCETRANS2METER
```
public static java.util.ArrayList DISTANCETRANS2METER
```
  - DEFAULT_SELECTION_COLOR
```
public static final java.awt.Color DEFAULT_SELECTION_COLOR
```
  - CHANGE
```
public static final double[] CHANGE
```
    Deprecated. use getDistanceTrans2Meter() * 100
    Defines the value which a unit of a distance measurement must be divided to obtain its equivalent in centimeters.
    
    Conversion values of distance measurements:
    - MapContext.CHANGE[0]: kilometer
    - MapContext.CHANGE[1]: meter
    - MapContext.CHANGE[2]: centimeter
    - MapContext.CHANGE[3]: millimeter
    - MapContext.CHANGE[4]: international statute mile
    - MapContext.CHANGE[5]: yard
    - MapContext.CHANGE[6]: foot
    - MapContext.CHANGE[7]: inch
    - MapContext.CHANGE[8]: grade
    Examples:
```
1 international statute mile / MapContext.CHANGE[4] = X centimeters
```
```
1 kilometer / MapContext.CHANGE[0] = X centimeters
```
```
1 grade / MapContext.CHANGE[8] = X centimeters
```
    Grade conversion value: MapContext.CHANGE[8]
    The value of MapContext.CHANGE[8] represents the centimeters of a straight line between two points on the Earth surface that are 1 grade far each other of the center of the Earth. This value has been calculated using a radius approximated of R_Earth=6.37846082678100774672e6 meters, according these equations:
```
D = 2 * (sin (1)) * R_Earth
```
```
MapContext.CHANGE[8] = 1 / D
```
    Explanation:
    We get an isosceles triangle with the center of the Earth and the 2 points on the surface. This triangle can be divided into two rectangle triangles. We know two values, the angle of 1 grade, that will be 0.50 grades in each triangle, and the Earth radius that is the hypotenuse. Then we apply trigonometry and get the distance D between both points on the Earth surface.
    
    Now we only must invert that value to obtain MapContext.CHANGE[8].
  - EQUALS
```
public static final int EQUALS
```
    See Also:
    
    Constant Field Values
  - DISJOINT
```
public static final int DISJOINT
```
    See Also:
    
    Constant Field Values
  - INTERSECTS
```
public static final int INTERSECTS
```
    See Also:
    
    Constant Field Values
  - TOUCHES
```
public static final int TOUCHES
```
    See Also:
    
    Constant Field Values
  - CROSSES
```
public static final int CROSSES
```
    See Also:
    
    Constant Field Values
  - WITHIN
```
public static final int WITHIN
```
    See Also:
    
    Constant Field Values
  - CONTAINS
```
public static final int CONTAINS
```
    See Also:
    
    Constant Field Values
  - OVERLAPS
```
public static final int OVERLAPS
```
    See Also:
    
    Constant Field Values
  - layers
```
protected FLayers layers
```
    A hierarchy of FLayers nodes.
  - ZOOMINFACTOR
```
public static double ZOOMINFACTOR
```
    Default zoom in factor.
    
    Doing a zoom in operation, decreases the focal distance and increases the eyesight angle to the surface. This allows view an smaller area but with the items bigger.
  - ZOOMOUTFACTOR
```
public static double ZOOMOUTFACTOR
```
    Default zoom out factor.
    
    Doing a zoom out operation, increases the focal distance and decreases the eyesight angle to the surface. This allows view a bigger area but with the items smaller.
- Constructor Detail
  - MapContext
```
public MapContext(ViewPort vp)
```
    Creates a new map context with the drawing information defined in the view port argument, and without layers.
    
    Parameters:
    
    vp - information for drawing the layers of this map in the available rectangular area according a projection
  - MapContext
```
public MapContext()
```
  - MapContext
```
public MapContext(FLayers fLayers,
                  ViewPort vp)
```
    Creates a new map context with the layers and the drawing information defined in the view port arguments.
    
    Parameters:
    
    fLayers - the initial hierarchy of nodes of layers that this map will have
    
    vp - information for drawing the layers of this map in the available rectangular area according a projection
- Method Detail
  - getDrawFrameRate
```
public static int getDrawFrameRate()
```
    Returns the draw frame rate.
    
    Draw frame rate is the number of repaints of this MapControl instance that timer invokes per second.
    
    Returns:
    
    number of repaints of this MapControl instance that timer invokes per second
    
    See Also:
    
    #applyFrameRate(), setDrawFrameRate(int)
  - setDrawFrameRate
```
public static void setDrawFrameRate(int theDrawFrameRate)
```
    Sets the draw frame rate.
    
    Draw frame rate is the number of repaints of this MapControl instance that timer invokes per second.
    
    Parameters:
    
    theDrawFrameRate - number of repaints of this MapControl instance that timer invokes per second
    
    See Also:
    
    #applyFrameRate(), getDrawFrameRate()
  - addAreaUnit
```
public static void addAreaUnit(java.lang.String name,
                               java.lang.String abbr,
                               boolean isLinear,
                               double trans2meter)
```
  - getAreaNames
```
public static java.lang.String[] getAreaNames()
```
  - getAreaAbbr
```
public static java.lang.String[] getAreaAbbr()
```
  - getAreaTrans2Meter
```
public static double[] getAreaTrans2Meter()
```
  - getOfLinear
```
public static java.lang.String getOfLinear(int i)
```
  - addDistanceUnit
```
public static void addDistanceUnit(java.lang.String name,
                                   java.lang.String abbr,
                                   double trans2meter)
```
  - getDistanceNames
```
public static java.lang.String[] getDistanceNames()
```
  - getDistanceName
```
public java.lang.String getDistanceName()
```
  - getDistanceAbbr
```
public static java.lang.String[] getDistanceAbbr()
```
  - getDistanceTrans2Meter
```
public static double[] getDistanceTrans2Meter()
```
  - getDistancePosition
```
public static int getDistancePosition(java.lang.String s)
```
  - getSelectionColor
```
public java.awt.Color getSelectionColor()
```
    Gets the color used to represent the selections.
    
    Returns:
    
    color used to represent the selections
  - setSelectionColor
```
public void setSelectionColor(java.awt.Color selectionColor)
```
    Sets the color used to represent the selections.
    
    Parameters:
    
    selectionColor - color used to represent the selections
  - reportDriverExceptions
```
public void reportDriverExceptions(java.lang.String introductoryText,
                                   java.util.List driverExceptions)
```
    Reports to all driver error listeners registered of a bundle of driver exceptions caused in the same map atomic transaction.
    
    Parameters:
    
    introductoryText - introductory text specified by developer. If null, use ""
    
    driverExceptions - list with a bundle of driver exceptions caught during an atomic event
    
    See Also:
    
    addErrorListener(ErrorListener), removeErrorListener(LegendListener)
  - addLayerListener
```
public void addLayerListener(LegendListener listener)
```
    Deprecated. use addLegendListener
    
    Adds the specified legend listener (if didn't exist) to receive legend events from this map.
    
    Parameters:
    
    listener - the legend listener
    
    See Also:
    
    removeLayerListener(LegendListener), callLegendChanged()
  - addLegendListener
```
public void addLegendListener(LegendListener listener)
```
    Adds the specified legend listener (if didn't exist) to receive legend events from this map.
    
    Parameters:
    
    listener - the legend listener
    
    See Also:
    
    removeLayerListener(LegendListener), callLegendChanged()
  - getLegendListeners
```
public java.util.List getLegendListeners()
```
  - addLayerDrawingListener
```
public void addLayerDrawingListener(LayerDrawingListener listener)
```
    Adds the specified layer drawing listener to catch and handle drawing events from layers of this map.
    
    Parameters:
    
    listener - the listener to add
    
    See Also:
    
    removeLayerDrawListener(LayerDrawingListener), fireLayerDrawingEvent(LayerDrawEvent)
  - getLayerDrawingListeners
```
public java.util.List getLayerDrawingListeners()
```
  - removeLayerDrawListener
```
public void removeLayerDrawListener(LayerDrawingListener listener)
```
    Removes the specified layer drawing listener from this map.
    
    Parameters:
    
    listener - the listener to remove
    
    See Also:
    
    addLayerDrawingListener(LayerDrawingListener), fireLayerDrawingEvent(LayerDrawEvent)
  - addErrorListener
```
public void addErrorListener(ErrorListener listener)
```
    Adds the specified error listener to receive error events from this map.
    
    Parameters:
    
    listener - the listener to add
    
    See Also:
    
    removeErrorListener(LegendListener), reportDriverExceptions(String, List)
  - getErrorListeners
```
public java.util.List getErrorListeners()
```
  - removeErrorListener
```
public void removeErrorListener(LegendListener listener)
```
    Removes the specified error listener from this map.
    
    Parameters:
    
    listener - the listener to remove
    
    See Also:
    
    addErrorListener(ErrorListener), reportDriverExceptions(String, List)
  - callLegendChanged
```
public void callLegendChanged()
```
    Notifies to all legend listeners registered, that one legend has changed. This method must be called only if it's wanted to reflect a legend change.
    
    See Also:
    
    addLayerListener(LegendListener), removeLayerListener(LegendListener)
  - fireLayerDrawingEvent
```
public void fireLayerDrawingEvent(LayerDrawEvent e)
```
    Fires a layer drawing event to all LayerDrawingListener listeners registered, distinguishing the kind of event.
    
    Parameters:
    
    e - the event
    
    See Also:
    
    addLayerDrawingListener(LayerDrawingListener), removeLayerDrawListener(LayerDrawingListener)
  - callNewErrorEvent
```
public void callNewErrorEvent(ErrorEvent e)
```
    Notifies to all error listeners registered, that one error has been produced.
    
    Parameters:
    
    e - the event with information of the error
    
    See Also:
    
    addErrorListener(ErrorListener), removeErrorListener(LegendListener), reportDriverExceptions(String, List)
  - removeLayerListener
```
public void removeLayerListener(LegendListener listener)
```
    Removes the specified layer listener from this map.
    
    Parameters:
    
    listener - the listener to remove
    
    See Also:
    
    addLayerListener(LegendListener), callLegendChanged()
  - getLayers
```
public FLayers getLayers()
```
    Returns the hierarchy of FLayers nodes stored in this map.
    
    Returns:
    
    the hierarchy of nodes of layers stored in this map
  - drawLabels
```
public void drawLabels(java.awt.image.BufferedImage b)
```
    Draws the visible layers of this map according its view port, on the image parameter.
    
    Parameters:
    
    b - image with an accessible buffer of image data
  - invalidate
```
public void invalidate()
```
    See Also:
    
    #redraw()
  - print
```
public void print(java.awt.Graphics2D g,
                  double scale,
                  PrintAttributes properties)
           throws ReadException,
                  MapContextException
```
    Prints the layers of this map using the Graphics2D argument, that usually is the Graphics of the printer.
    
    Parameters:
    
    g - for rendering 2-dimensional shapes, text and images on the Java(tm) platform
    
    scale - the scale of the view. Must be between FLayer.getMinScale() and FLayer.getMaxScale().
    
    properties - a set with the settings to be applied to a whole print job and to all the documents in the print job
    
    Throws:
    
    MapContextException - if there is an error getting the instance of MapContextDrawer
    
    ReadDriverException - if fails reading with driver.
    
    ReadException
    
    See Also:
    
    FLayer.draw(BufferedImage, Graphics2D, ViewPort, Cancellable, double)
  - createNewFMap
```
public MapContext createNewFMap(ViewPort vp)
```
    Returns a new MapContext instance with the information of the vp argument, and the layers of this map.
    
    Parameters:
    
    vp - information for drawing the layers of this map in the available rectangular area according a projection
    
    Returns:
    
    a new MapContext instance projected by vp
  - cloneFMap
```
public MapContext cloneFMap()
```
    Creates a new independent MapContext instance, that has a clone of the layers and the view port of this one.
    
    The new map will have the same data source drivers to avoid waste memory, and work faster.
    
    Returns:
    
    the new MapContext instance
    
    Throws:
    
    XMLException - if fails cloning the view port or a layer
    
    See Also:
    
    FLayer.cloneLayer(), ViewPort#cloneViewPort()
  - cloneToDraw
```
public MapContext cloneToDraw()
```
    Like cloneFMap(), but now doesn't clone the layers, rather copies them.
    
    Returns:
    
    the new map
  - addToTrackLayer
```
public void addToTrackLayer(FLayer vectorial)
```
    Adds a layer to the group of layers that are at a upper level in the tree.
    
    Parameters:
    
    vectorial - the layer to add
  - getScaleView
```
public double getScaleView()
```
    Returns the scale of the view in the screen.
    Returns:
    one of this values:
    
    the scale of the adjusted extent scale of the view in the screen
    -1 if there is no image
    0 if there is no extent defined for the image
    See Also:
    
    #setScaleView(long), ViewPort.getAdjustedExtent(), IProjection.getScale(double, double, double, double)
  - setScaleView
```
public void setScaleView(double scale)
```
    Sets the new extent of the view, calculated using the scale argument.
    
    Doesn't updates the scale if there isn't information about the dimension of the image or the adjusted extent.
    
    Parameters:
    
    scale - the new scale for the view
    
    See Also:
    
    ViewPort.setProjection(IProjection), getScaleView()
  - getScreenDPI
```
public static double getScreenDPI()
```
    Returns the screen resolution (Dots Per Inch) as it was defined by the user's preference, or by default as it is defined in the default Toolkit.
    Be care, use ViewPort#getDPI to ensure are using the corrects DPI.
    
    Returns:
    
    double with the screen's dpi
  - process
```
public void process(Visitor visitor)
```
    See Also:
    
    org.gvsig.fmap.mapcontext.rendering.strategies.Strategy#process(com.iver.cit.gvsig.fmap.FeatureSelectorVisitor)
  - processSelected
```
public void processSelected(Visitor visitor)
```
    See Also:
    
    org.gvsig.fmap.mapcontext.rendering.strategies.Strategy#processSelected(com.iver.cit.gvsig.fmap.FeatureVisitor)
  - select
```
public void select(Visitor visitor)
```
    See Also:
    
    org.gvsig.fmap.mapcontext.rendering.strategies.Strategy#select(com.iver.cit.gvsig.fmap.FeatureSelectorVisitor, VectorialSubSet)
  - selectFromSelection
```
public void selectFromSelection()
```
    See Also:
    
    org.gvsig.fmap.mapcontext.rendering.strategies.Strategy#selectFromSelection()
  - createIndex
```
public void createIndex()
```
    See Also:
    
    org.gvsig.fmap.mapcontext.rendering.strategies.Strategy#createIndex()
  - getProjection
```
public IProjection getProjection()
```
    Description copied from interface: Projected
    
    Returns the current projection.
    
    Specified by:
    
    getProjection in interface Projected
    
    Returns:
    
    current projection
    
    See Also:
    
    Projected.getProjection(), ViewPort.getProjection(), setProjection(IProjection), reProject(ICoordTrans)
  - setProjection
```
public void setProjection(IProjection proj)
```
    Sets the new projection.
    
    Parameters:
    
    proj - the new projection
    
    See Also:
    
    getProjection(), ViewPort.setProjection(IProjection), reProject(ICoordTrans)
  - reProject
```
public void reProject(ICoordTrans arg0)
```
    Description copied from interface: Projected
    
    Changes projection of the graphical information of this object.
    
    Specified by:
    
    reProject in interface Projected
    
    Parameters:
    
    arg0 - transformation coordinates for obtaining the new projection
    
    See Also:
    
    Projected.reProject(org.cresques.cts.ICoordTrans)
  - getSelectionBounds
```
public Envelope getSelectionBounds()
                            throws BaseException
```
    Throws:
    
    BaseException
  - draw
```
public void draw(java.awt.image.BufferedImage image,
                 java.awt.Graphics2D g,
                 Cancellable cancel,
                 double scale)
          throws ReadException,
                 MapContextException
```
    Draws this map if its ViewPort has an extent defined:
    1. Selects only the layers that have to be drawn: #prepareDrawing(BufferedImage, Graphics2D, double).
    2. Sets quality: antialiasing by text and images, and quality rendering.
    3. Draws the layers.
    4. Fires a LayerDrawEvent.GRAPHICLAYER_BEFORE_DRAW.
    5. Draws the graphic layer.
    6. Fires a LayerDrawEvent.GRAPHICLAYER_AFTER_DRAW.
    7. Invokes the garbage collector and memory clean.
    Parameters:
    
    image - buffer used sometimes instead g to accelerate the draw. For example, if two points are as closed that can't be distinguished, draws only one.
    
    g - for rendering 2-dimensional shapes, text and images on the Java(tm) platform
    
    cancel - shared object that determines if this layer can continue being drawn
    
    scale - the scale of the view. Must be between FLayer.getMinScale() and FLayer.getMaxScale().
    
    Throws:
    
    MapContextException - if there is an error getting the instance of MapContextDrawer
    
    ReadDriverException - if fails reading with the driver.
    
    ReadException
  - drawGraphics
```
public void drawGraphics(java.awt.image.BufferedImage image,
                         java.awt.Graphics2D g,
                         Cancellable cancel,
                         double scale)
                  throws ReadException
```
    Deprecated. use draw(BufferedImage, Graphics2D, Cancellable, double) instead
    
    Draws only the internal graphic layer using the information of the ViewPort of this map.
    
    Parameters:
    
    image - image used to accelerate the screen draw
    
    g - for rendering 2-dimensional shapes, text and images on the Java(tm) platform
    
    cancel - shared object that determines if this layer can continue being drawn
    
    scale - value that represents the scale
    
    Throws:
    
    ReadDriverException - if fails reading with the driver.
    
    ReadException
    
    See Also:
    
    FLayer.draw(BufferedImage, Graphics2D, ViewPort, Cancellable, double)
  - draw
```
public void draw(java.awt.image.BufferedImage image,
                 java.awt.Graphics2D g,
                 double scale)
          throws ReadException,
                 MapContextException
```
    Like draw(BufferedImage, Graphics2D, Cancellable, double) , but creating the task as cancellable.
    
    Parameters:
    
    image - buffer used sometimes instead g to accelerate the draw. For example, if two points are as closed that can't be distinguished, draws only one.
    
    g - for rendering 2-dimensional shapes, text and images on the Java(tm) platform
    
    scale - the scale of the view. Must be between FLayer.getMinScale() and FLayer.getMaxScale().
    
    Throws:
    
    MapContextException - if there is an error getting the instance of MapContextDrawer
    
    ReadDriverException - if the driver fails reading.
    
    ReadException
    
    See Also:
    
    draw(BufferedImage, Graphics2D, Cancellable, double)
  - getViewPort
```
public ViewPort getViewPort()
```
    Gets the ViewPort associated to this map.
    
    Returns:
    
    the view port
    
    See Also:
    
    setViewPort(ViewPort)
  - setViewPort
```
public void setViewPort(ViewPort viewPort)
```
    Sets a ViewPort with the drawing information of this map.
    
    If there was a previous view port, removes its EventBuffer and adds the new one.
    
    Parameters:
    
    viewPort - the viewPort
    
    See Also:
    
    getViewPort()
  - zoomToEnvelope
```
public void zoomToEnvelope(Envelope env)
```
    Sets the given extent to the ViewPort and updates the view with the new zoom.
    
    Parameters:
    
    extent - the extent of the new zoom
  - getFullEnvelope
```
public Envelope getFullEnvelope()
                         throws ReadException
```
    Returns the union of all extents of all layers of this map.
    
    Returns:
    
    full extent of layers of this map
    
    Throws:
    
    ReadDriverException - if the driver fails reading.
    
    ReadException
    
    See Also:
    
    FLayers.getFullEnvelope()
  - addAtomicEventListener
```
public boolean addAtomicEventListener(AtomicEventListener listener)
```
    Adds a listener of atomic events to the internal EventBuffer.
    
    Parameters:
    
    listener - the new listener
    
    Returns:
    
    true if has added the listener successfully
    
    See Also:
    
    removeAtomicEventListener(AtomicEventListener), EventBuffer.addAtomicEventListener(AtomicEventListener)
  - getAtomicEventListeners
```
public java.util.List getAtomicEventListeners()
```
  - removeAtomicEventListener
```
public boolean removeAtomicEventListener(AtomicEventListener listener)
```
    Removes a listener of atomic events from the internal EventBuffer.
    
    Parameters:
    
    listener - the listener to remove
    
    Returns:
    
    true if the list contained the specified element
    
    See Also:
    
    addAtomicEventListener(AtomicEventListener), EventBuffer.removeAtomicEventListener(AtomicEventListener)
  - beginAtomicEvent
```
public void beginAtomicEvent()
```
    See Also:
    
    EventBuffer.beginAtomicEvent(), endAtomicEvent()
  - endAtomicEvent
```
public void endAtomicEvent()
```
    See Also:
    
    EventBuffer.endAtomicEvent(), beginAtomicEvent()
  - addAsCollectionListener
```
public void addAsCollectionListener(FLayers layers2)
```
    Adds the LayerEventListener of this map to the collection of layers argument.
    
    Parameters:
    
    a - collection of layers
  - getGraphicsLayer
```
public VectorLayer getGraphicsLayer(java.lang.String name)
```
  - getGraphicsLayers
```
public java.util.Collection<VectorLayer> getGraphicsLayers()
```
  - setGraphicsLayer
```
public void setGraphicsLayer(java.lang.String name,
                             FLyrVect layer)
```
  - removeGraphicsLayer
```
public void removeGraphicsLayer(java.lang.String name)
```
  - getGraphicsLayer
```
public GraphicLayer getGraphicsLayer()
```
    Returns the internal GraphicLayer.
    
    Returns:
    
    the graphic layer of this map
    
    See Also:
    
    setGraphicsLayer(GraphicLayer)
  - setGraphicsLayer
```
public void setGraphicsLayer(GraphicLayer graphicLayer)
```
    Sets a new GraphicLayer to this map.
    
    Parameters:
    
    graphicLayer - the new graphic layer
    
    See Also:
    
    getGraphicsLayer()
  - equals
```
public boolean equals(java.lang.Object arg0)
```
    Indicates whether some other object is "equal to" this map.
    
    Returns true if success one of this options:
    - Both objects are equal according to Object.equals(Object).
    - Both maps have the same layers.
    - Both maps have the same number of layers and with the same name.
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - the reference object with which to compare.
    
    Returns:
    
    true if this object is the same as the arg0 argument; otherwise false.
    
    See Also:
    
    Object.equals(Object)
  - addLayerError
```
public void addLayerError(java.lang.String stringProperty)
```
    Registers the message of an error associated to this map.
    
    Parameters:
    
    stringProperty - the error message
    
    See Also:
    
    getLayersError(), clearErrors()
  - getLayersError
```
public java.util.ArrayList getLayersError()
```
    Gets the list with all error messages registered to this map.
    
    Returns:
    
    the list of errors registered to this map
    
    See Also:
    
    addLayerError(String), clearErrors()
  - clearErrors
```
public void clearErrors()
```
    Removes all error messages associated to this map.
    
    See Also:
    
    addLayerError(String), getLayersError()
  - getNewGroupLayer
```
public FLayers getNewGroupLayer(FLayers parent)
```
    Creates and returns a new group of layers that belongs to this MapContext.
    
    Parameters:
    
    parent - layer node in this MapContexte that will be the parent of the new node
    
    Returns:
    
    the new layer node
  - getClassName
```
public java.lang.String getClassName()
```
  - getLayersToSnap
```
public java.util.Set<FLyrVect> getLayersToSnap()
```
  - setLayersToSnap
```
public void setLayersToSnap(java.util.Set<FLyrVect> layers)
```
    Adds the layers to the current "layersToSnap" without replacing the current instance of "layersToSnap"
    
    Parameters:
    
    layers -
  - update
```
public void update(Observable observable,
                   java.lang.Object notification)
```
    Description copied from interface: Observer
    
    Called whenever a Observable object is changed and this Observer has registered on it to receive notifications.
    Implementations of this method will be called for each simple notification or, if a complex notification is created, for each of the child notifications.
    
    In the latter case, don't assume any ordering in the notification between this Observer and other Observers listening to the same Observable.
    
    In a complex notification scenario, if you want to receive only the complex notification and not each of the child notifications, just implement the ComplexObserver and prepare this method implementation to handle receiving DefaultComplexNotification instances as well as direct notification objects.
    
    Specified by:
    
    update in interface Observer
    
    Parameters:
    
    observable - the observable object.
    
    notification - the notification data.
  - getDrawVersion
```
public long getDrawVersion()
```
  - updateDrawVersion
```
protected void updateDrawVersion()
```
  - getMapContextDrawer
```
public MapContextDrawer getMapContextDrawer()
                                     throws ReadException,
                                            MapContextException
```
    Throws:
    
    ReadException
    
    MapContextException
  - setMapContextDrawerClass
```
public void setMapContextDrawerClass(java.lang.Class mapContextDrawerClass)
                              throws MapContextException
```
    Throws:
    
    MapContextException
  - setMapContextDrawer
```
public void setMapContextDrawer(MapContextDrawer drawer)
```
  - 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
  - doDispose
```
protected void doDispose()
                  throws BaseException
```
    Description copied from class: AbstractDisposable
    
    Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
    
    Specified by:
    
    doDispose in class AbstractDisposable
    
    Throws:
    
    BaseException
    
    See Also:
    
    AbstractDisposable.dispose()
  - addSelectionListener
```
public void addSelectionListener(FLayer lyr)
```
    Registers an event buffer as a listener for all layers as argument.
    
    Each FLayer of this map must have an event buffer for all kind of specific listeners of that layer. This method distinguish between Classifiable, AlphanumericData, and FLayers layers, and for each one, registers, for their specific listeners, the eventBuffer as a listener.
    
    Parameters:
    
    the - layer or layers
  - setOrderManager
```
public void setOrderManager(LayerOrderManager lom)
```
  - getOrderManager
```
public LayerOrderManager getOrderManager()
```
  - hasVectorLayers
```
public boolean hasVectorLayers()
```
  - hasActiveVectorLayers
```
public boolean hasActiveVectorLayers()
```
  - hasActiveLayers
```
public boolean hasActiveLayers()
```
  - hasLayers
```
public boolean hasLayers()
```
  - iterator
```
public java.util.Iterator<FLayer> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<FLayer>
  - deepiterator
```
public java.util.Iterator deepiterator()
```
  - getTimeContext
```
public MapContext.MapTimeContext getTimeContext()
```
  - getScaleToUseWhenEnvelopeCollapse
```
public long getScaleToUseWhenEnvelopeCollapse()
```
  - setScaleToUseWhenEnvelopeCollapse
```
public void setScaleToUseWhenEnvelopeCollapse(long scale)
```
  - setPrintGraphicsLayer
```
public void setPrintGraphicsLayer(boolean b)
```
  - isPrintGraphicsLayer
```
public boolean isPrintGraphicsLayer()
```

Class MapContext

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.gvsig.tools.dispose.impl.AbstractDisposable

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

CHANGEM

AREANAMES

AREAABBR

AREATRANS2METER

DISTANCENAMES

DISTANCEABBR

DISTANCETRANS2METER

DEFAULT_SELECTION_COLOR

CHANGE

Examples:

Grade conversion value: MapContext.CHANGE[8]

Explanation:

EQUALS

DISJOINT

INTERSECTS

TOUCHES

CROSSES

WITHIN

CONTAINS

OVERLAPS

layers

ZOOMINFACTOR

ZOOMOUTFACTOR

Constructor Detail

MapContext

MapContext

MapContext

Method Detail

getDrawFrameRate

setDrawFrameRate

addAreaUnit

getAreaNames

getAreaAbbr

getAreaTrans2Meter

getOfLinear

addDistanceUnit

getDistanceNames

getDistanceName

getDistanceAbbr

getDistanceTrans2Meter

getDistancePosition

getSelectionColor

setSelectionColor

reportDriverExceptions

addLayerListener

addLegendListener

getLegendListeners

addLayerDrawingListener

getLayerDrawingListeners

removeLayerDrawListener

addErrorListener

getErrorListeners

removeErrorListener

callLegendChanged

fireLayerDrawingEvent

callNewErrorEvent

removeLayerListener

getLayers

drawLabels

invalidate

print

createNewFMap

cloneFMap

cloneToDraw

addToTrackLayer

getScaleView

setScaleView

getScreenDPI

process

processSelected

select

Grade conversion value: `MapContext.CHANGE[8]`