FLyrDefault

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

All Implemented Interfaces:

Projected, ExtendedPropertiesSupport, FLayer, FLayerHidesArea, LayerListener, Metadata, Disposable, DynObject, Persistent

Direct Known Subclasses:

DefaultFLyrRaster, DefaultRasterLayer, FLayers, FLyrVect
```
public abstract class FLyrDefault
extends AbstractDisposable
implements FLayer, FLayerHidesArea, LayerListener
```
Implementation of the common characteristics of all layers: visibility, activation, name, ...

Represents the definition of a basic layer, implementing FLayer, and new functionality:
- Supports transparency.
- Notification of evens produced using this layer.
- Can have internal virtual layers.
- Can have a text layer.
- Supports an strategy for visit its geometries.
- Can have an image in the TOC (table of contents) associated to the state of this layer.
Each graphical layer will inherit from this class and adapt to its particular logic and model according its nature.
See Also:

FLayer, FLayerStatus

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FLyrDefault.RegisterMetadata

static class FLyrDefault.RegisterPersistence

Nested Classes
Modifier and Type	Class and Description
`static class`	`FLyrDefault.RegisterMetadata`
`static class`	`FLyrDefault.RegisterPersistence`

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`drawVersion` Draw version of the context.
`protected java.util.Set<LayerListener>`	`layerListeners` Array list with all listeners registered to this layer.
`protected MetadataContainer`	`metadataContainer`
`protected ExtendedPropertiesHelper`	`properties`

Fields inherited from interface org.gvsig.fmap.mapcontext.layers.FLayer
METADATA_CRS, METADATA_DEFINITION_DESCRIPTION, METADATA_DEFINITION_NAME, METADATA_NAME

Constructor Summary

Constructors
Constructor and Description

FLyrDefault()

FLyrDefault(MetadataContainer metadataContainer)

Constructors
Constructor and Description
`FLyrDefault()`
`FLyrDefault(MetadataContainer metadataContainer)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`activationChanged(LayerEvent e)` Called when the activation of a layer has changed.
`void`	`addError(java.lang.Throwable exception)` Adds an error reason that describes this layer's wrong status.
`boolean`	`addLayerListener(LayerListener o)` Adds a `LayerListener` to the listener list.
`void`	`addLegendListener(LegendListener listener)`
`boolean`	`allowLinks()` Alwais return false
`protected void`	`callEditionChanged(LayerEvent e)` Called by some version of the method setEditing(boolean) overwritten.
`protected void`	`callLegendChanged(LegendChangedEvent e)`
`void`	`clear()`
`FLayer`	`cloneLayer()` This method can be used to have a fast cloned layer.
`void`	`delegate(DynObject dynObject)`
`void`	`drawValueChanged(LayerEvent e)` Called when a draw value of a layer has changed.
`void`	`editionChanged(LayerEvent e)` Called when the edition of a layer has changed.
`java.lang.String`	`getClassName()`
`ICoordTrans`	`getCoordTrans()` Returns the transformation coordinates of this layer.
`int`	`getDefaultTolerance()` Returns layer tolerance in pixels
`long`	`getDrawVersion()`
`DynClass`	`getDynClass()`
`java.lang.Object`	`getDynValue(java.lang.String name)`
`java.lang.Throwable`	`getError(int i)` Returns the specified error.
`java.util.List<java.lang.Throwable>`	`getErrors()` Returns a list with all layer errors.
`java.util.Map`	`getExtendedProperties()` Returns a hash map with all new properties associated to this layer.
`FLayerStatus`	`getFLayerStatus()` Returns the status of this layer.
`java.lang.String`	`getInfoString()` Returns an string with the information of this layer.
`LayerListener[]`	`getLayerListeners()` Returns all `LayerListener`s of this layer as an array.
`java.net.URI[]`	`getLink(java.awt.geom.Point2D point, double tolerance)` alwais return null
`AbstractLinkProperties`	`getLinkProperties()` Alwais return null.
`MapContext`	`getMapContext()` Returns a reference to the model of this layer, or null if this layer has no model.
`double`	`getMaxScale()` Returns the maximum scale visible.
`java.lang.String`	`getMetadataName()` Returns the name of the Metadata, which allows to identify the type in the Metadata registry.
`double`	`getMinScale()` Returns the minimum scale visible.
`java.lang.String`	`getName()` Returns the name of this layer.
`int`	`getNumErrors()` Returns the number of errors which causes this layer to be in unavailable status.
`FLayers`	`getParentLayer()` Returns the parent `FLayers` node of this layer.
`IProjection`	`getProjection()` Returns the current projection.
`java.lang.Object`	`getProperty(java.lang.Object key)` Returns a reference to an object (property) associated to this layer.
`java.lang.String`	`getTocImageIcon()` Returns the image icon that will be shown in the TOC next to this layer.
`java.awt.Image`	`getTocStatusImage()` Returns the image icon that will be shown in the TOC next to this layer, according its status.
`int`	`getTransparency()` Returns the transparency level of this layer, in the range 0-255 .
`boolean`	`hasChangedForDrawing(long value)`
`boolean`	`hasDynValue(java.lang.String name)`
`boolean`	`hidesThisArea(Envelope area)`
`void`	`implement(DynClass dynClass)`
`void`	`invalidate()`
`java.lang.Object`	`invokeDynMethod(int code, java.lang.Object[] args)`
`java.lang.Object`	`invokeDynMethod(java.lang.String name, java.lang.Object[] args)`
`boolean`	`isActive()` Returns if this layer is active or not in TOC.
`boolean`	`isAvailable()` Returns the status of availability of this layer.
`boolean`	`isEditing()` Returns if this layer is editable.
`boolean`	`isInTOC()` Returns if this layer appears in the TOC.
`boolean`	`isOk()` Returns if this layer hasn't got errors.
`boolean`	`isTemporary()`
`boolean`	`isVisible()` Returns if this layer is visible and available.
`boolean`	`isWithinScale(double scale)` Returns if the value of `scale` argument is within the maximum and minimum scale of this layer.
`boolean`	`isWritable()` Returns the writing status of this layer.
`void`	`load()` Executes the initialization operations of this layer.
`void`	`loadFromState(PersistentState state)` Set the state of the object from the state passed as parameter.
`void`	`nameChanged(LayerEvent e)` Called when the name of a layer has changed.
`ComposedLayer`	`newComposedLayer()` Returns a new instance of `ComposedLayer`.
`void`	`reload()` Tries recover a layer of a possible error.
`boolean`	`removeLayerListener(LayerListener o)` Removes the `LayerListener` argument from this layer.
`void`	`removeLegendListener(LegendListener listener)`
`void`	`reProject(ICoordTrans arg0)` Changes the projection of this layer.
`void`	`saveToState(PersistentState state)` Saves the internal state of the object on the provided PersistentState object.
`void`	`setActive(boolean selected)` Changes the status of this layer to active or inactive.
`void`	`setAvailable(boolean available)` Changes the status of availability of this layer.
`void`	`setCoordTrans(ICoordTrans ct)` Sets transformation coordinates for this layer.
`void`	`setDynValue(java.lang.String name, java.lang.Object value)`
`void`	`setEditing(boolean b)` Do nothing.
`void`	`setError(java.lang.Throwable ex)`
`void`	`setFLayerStatus(FLayerStatus status)` Sets the status of this layer.
`void`	`setInTOC(boolean b)` Sets that this layer appears or not in the TOC.
`void`	`setMaxScale(double maxScale)` Sets the maximum scale visible.
`void`	`setMinScale(double minScale)` Sets the minimum scale visible.
`void`	`setName(java.lang.String name)` Sets a name to this layer.
`void`	`setParentLayer(FLayers root)` Inserts the parent `FLayers` node of the layer.
`void`	`setProjection(IProjection proj)` Inserts the projection to this layer.
`void`	`setProperty(java.lang.Object key, java.lang.Object val)` Inserts an object as a property to this layer.
`void`	`setTemporary(boolean temporary)`
`void`	`setTocStatusImage(java.awt.Image tocStatusImage)` Inserts the image icon that will be shown in the TOC next to this layer, according its status.
`void`	`setTransparency(int trans)` Inserts the transparency level for this layer, the range allowed is 0-255 .
`void`	`setVisible(boolean visibility)` Changes the status of this layer to visible or not.
`java.lang.String`	`toString()`
`protected void`	`updateDrawVersion()`
`protected void`	`updateDrawVersion(boolean fireEvents)`
`void`	`visibilityChanged(LayerEvent e)` Called when the visibility of a layer has changed.
`boolean`	`visibleRequired()` Returns `true` if this layer has the visible status enabled.
`void`	`wakeUp()` Deprecated. no deberia ser necesario llamar a esto, la capa debe comportarse correctamente sin necesidad de llamarlo.

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

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

Methods inherited from interface org.gvsig.fmap.mapcontext.layers.FLayer
draw, getFullEnvelope, print

Methods inherited from interface org.gvsig.metadata.Metadata
getMetadataChildren, getMetadataID

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

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

- Field Detail
  - layerListeners
```
protected java.util.Set<LayerListener> layerListeners
```
    Array list with all listeners registered to this layer.
    
    See Also:
    
    getLayerListeners(), removeLayerListener(LayerListener), callEditionChanged(LayerEvent)
  - metadataContainer
```
protected MetadataContainer metadataContainer
```
  - drawVersion
```
protected long drawVersion
```
    Draw version of the context. It's used for know when de componend has changed any visualization property
    
    See Also:
    
    getDrawVersion, updateDrawVersion
  - properties
```
protected ExtendedPropertiesHelper properties
```
- Constructor Detail
  - FLyrDefault
```
public FLyrDefault(MetadataContainer metadataContainer)
```
  - FLyrDefault
```
public FLyrDefault()
```
- Method Detail
  - getProperty
```
public java.lang.Object getProperty(java.lang.Object key)
```
    Description copied from interface: ExtendedPropertiesSupport
    
    Returns a reference to an object (property) associated to this layer.
    
    For example, you can attach a network definition to key "network" and check if a layer has a network loaded using getAssociatedObject("network") and that it's not null.
    
    Specified by:
    
    getProperty in interface ExtendedPropertiesSupport
    
    Parameters:
    
    key - the key associated to the property
    
    Returns:
    
    null if key is not found
    
    See Also:
    
    ExtendedPropertiesSupport.getExtendedProperties(), ExtendedPropertiesSupport.setProperty(Object, Object)
  - setProperty
```
public void setProperty(java.lang.Object key,
                        java.lang.Object val)
```
    Description copied from interface: ExtendedPropertiesSupport
    
    Inserts an object as a property to this layer.
    
    Specified by:
    
    setProperty in interface ExtendedPropertiesSupport
    
    Parameters:
    
    key - the key associated to the property
    
    val - the property
    
    See Also:
    
    ExtendedPropertiesSupport.getProperty(Object), ExtendedPropertiesSupport.getExtendedProperties()
  - getExtendedProperties
```
public java.util.Map getExtendedProperties()
```
    Description copied from interface: ExtendedPropertiesSupport
    
    Returns a hash map with all new properties associated to this layer.
    
    Specified by:
    
    getExtendedProperties in interface ExtendedPropertiesSupport
    
    Returns:
    
    hash table with the added properties
    
    See Also:
    
    ExtendedPropertiesSupport.getProperty(Object), ExtendedPropertiesSupport.setProperty(Object, Object)
  - setActive
```
public void setActive(boolean selected)
```
    Description copied from interface: FLayer
    
    Changes the status of this layer to active or inactive.
    
    One layer is active if is selected in TOC.
    
    Specified by:
    
    setActive in interface FLayer
    
    Parameters:
    
    selected - the boolean to be set
    
    See Also:
    
    FLayer.isActive()
  - isActive
```
public boolean isActive()
```
    Description copied from interface: FLayer
    
    Returns if this layer is active or not in TOC.
    
    One layer is active if is selected in TOC.
    
    Specified by:
    
    isActive in interface FLayer
    
    Returns:
    
    true if this layer is active; false otherwise
    
    See Also:
    
    FLayer.setActive(boolean)
  - setName
```
public void setName(java.lang.String name)
```
    Description copied from interface: FLayer
    
    Sets a name to this layer.
    
    Specified by:
    
    setName in interface FLayer
    
    Parameters:
    
    name - the string that is to be this layer's name
    
    See Also:
    
    FLayer.getName()
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: FLayer
    
    Returns the name of this layer.
    
    Specified by:
    
    getName in interface FLayer
    
    Returns:
    
    an string with this layer's name
    
    See Also:
    
    FLayer.setName(String)
  - load
```
public void load()
          throws LoadLayerException
```
    Description copied from interface: FLayer
    
    Executes the initialization operations of this layer. This method is invoked only one time during the life of this layer and just before visualize it.
    
    Specified by:
    
    load in interface FLayer
    
    Throws:
    
    LoadLayerException - if fails loading the layer.
    
    See Also:
    
    FLayer.reload()
  - setVisible
```
public void setVisible(boolean visibility)
```
    Description copied from interface: FLayer
    
    Changes the status of this layer to visible or not.
    
    One layer is visible if it's check box associated is selected. This means that layer will tried to be painted. If the data associated isn't available, then this property will change to false.
    
    Specified by:
    
    setVisible in interface FLayer
    
    Parameters:
    
    visibility - the boolean to be set
    
    See Also:
    
    FLayer.isVisible(), FLayer.visibleRequired(), FLayer.isAvailable()
  - isVisible
```
public boolean isVisible()
```
    Description copied from interface: FLayer
    
    Returns if this layer is visible and available.
    
    One layer is visible if it's check box associated is selected. This means that layer will tried to be painted.
    
    One layer is available if the source of data is on-line.
    
    It's probably that one layer selected hadn't available it's data, for example in a remote service.
    
    Specified by:
    
    isVisible in interface FLayer
    
    Returns:
    
    true if this layer is visible and available; false otherwise
    
    See Also:
    
    FLayer.isAvailable(), FLayer.setAvailable(boolean), FLayer.visibleRequired()
  - getParentLayer
```
public FLayers getParentLayer()
```
    Description copied from interface: FLayer
    
    Returns the parent FLayers node of this layer.
    
    Specified by:
    
    getParentLayer in interface FLayer
    
    Returns:
    
    the parent of this layer, or null if hasn't parent
    
    See Also:
    
    FLayer.setParentLayer(FLayers)
  - setParentLayer
```
public void setParentLayer(FLayers root)
```
    Description copied from interface: FLayer
    
    Inserts the parent FLayers node of the layer.
    
    Specified by:
    
    setParentLayer in interface FLayer
    
    Parameters:
    
    root - a FLayers object
    
    See Also:
    
    FLayer.getParentLayer()
  - setProjection
```
public void setProjection(IProjection proj)
```
    Inserts the projection to this layer.
    
    Specified by:
    
    setProjection in interface FLayer
    
    Parameters:
    
    proj - information about the new projection
    
    See Also:
    
    #isReprojectable(), #reProject(MapControl)
  - 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.reProject(ICoordTrans)
  - reProject
```
public void reProject(ICoordTrans arg0)
```
    Changes the projection of this layer.
    
    This method will be overloaded in each kind of layer, according its specific nature.
    
    Specified by:
    
    reProject in interface Projected
    
    Parameters:
    
    arg0 -
    
    See Also:
    
    #isReprojectable(), setProjection(IProjection)
  - getTransparency
```
public int getTransparency()
```
    Returns the transparency level of this layer, in the range 0-255 .
    
    Returns:
    
    the transparency level
    
    See Also:
    
    setTransparency(int)
  - setTransparency
```
public void setTransparency(int trans)
```
    Inserts the transparency level for this layer, the range allowed is 0-255 .
    
    Parameters:
    
    trans - the transparency level
    
    See Also:
    
    getTransparency()
  - getMapContext
```
public MapContext getMapContext()
```
    Description copied from interface: FLayer
    
    Returns a reference to the model of this layer, or null if this layer has no model.
    
    Specified by:
    
    getMapContext in interface FLayer
    
    Returns:
    
    the model of this layer
  - addLayerListener
```
public boolean addLayerListener(LayerListener o)
```
    Description copied from interface: FLayer
    
    Adds a LayerListener to the listener list.
    
    Specified by:
    
    addLayerListener in interface FLayer
    
    Parameters:
    
    o - a layer listener
    
    Returns:
    
    true if hasn't been any problem during the insertion of the listener
    
    See Also:
    
    FLayer.getLayerListeners(), FLayer.removeLayerListener(LayerListener)
  - getLayerListeners
```
public LayerListener[] getLayerListeners()
```
    Description copied from interface: FLayer
    
    Returns all LayerListeners of this layer as an array.
    
    Specified by:
    
    getLayerListeners in interface FLayer
    
    Returns:
    
    an array with all layer listeners associated to this layer
    
    See Also:
    
    FLayer.addLayerListener(LayerListener), FLayer.removeLayerListener(LayerListener)
  - removeLayerListener
```
public boolean removeLayerListener(LayerListener o)
```
    Description copied from interface: FLayer
    
    Removes the LayerListener argument from this layer.
    
    Specified by:
    
    removeLayerListener in interface FLayer
    
    Parameters:
    
    o - a layer listener
    
    Returns:
    
    true if hasn't been any problem doing this process
    
    See Also:
    
    FLayer.addLayerListener(LayerListener), FLayer.getLayerListeners()
  - setCoordTrans
```
public void setCoordTrans(ICoordTrans ct)
```
    Sets transformation coordinates for this layer.
    
    Specified by:
    
    setCoordTrans in interface FLayer
    
    Parameters:
    
    ct - an object that implements the ICoordTrans interface, and with the transformation coordinates
    
    See Also:
    
    getCoordTrans()
  - getCoordTrans
```
public ICoordTrans getCoordTrans()
```
    Returns the transformation coordinates of this layer.
    
    Specified by:
    
    getCoordTrans in interface FLayer
    
    Returns:
    
    an object that implements the ICoordTrans interface, and with the transformation coordinates
    
    See Also:
    
    setCoordTrans(ICoordTrans)
  - wakeUp
```
public void wakeUp()
            throws LoadLayerException
```
    Deprecated. no deberia ser necesario llamar a esto, la capa debe comportarse correctamente sin necesidad de llamarlo.
    
    Method called by FLayers to notify this layer that is going to be added.This previous notification is useful for the layers that need do something before being added. For example, the raster needs reopen a file that could have been closed recently.
    
    Throws:
    
    LoadLayerException
  - getMinScale
```
public double getMinScale()
```
    Description copied from interface: FLayer
    
    Returns the minimum scale visible. Lower scales won't be drawn.
    
    Specified by:
    
    getMinScale in interface FLayer
    
    Returns:
    
    the minimum scale > 0, -1 if not defined
    
    See Also:
    
    FLayer.setMinScale(double)
  - getMaxScale
```
public double getMaxScale()
```
    Description copied from interface: FLayer
    
    Returns the maximum scale visible. Higher scales won't be drawn.
    
    Specified by:
    
    getMaxScale in interface FLayer
    
    Returns:
    
    the maximum scale > 0, -1 if not defined
    
    See Also:
    
    FLayer.setMaxScale(double)
  - setMinScale
```
public void setMinScale(double minScale)
```
    Description copied from interface: FLayer
    
    Sets the minimum scale visible. Lower scales won't be drawn.
    
    Specified by:
    
    setMinScale in interface FLayer
    
    Parameters:
    
    minScale - the scale > 0, -1 if not defined
    
    See Also:
    
    FLayer.getMinScale()
  - setMaxScale
```
public void setMaxScale(double maxScale)
```
    Description copied from interface: FLayer
    
    Sets the maximum scale visible. Higher scales won't be drawn.
    
    Specified by:
    
    setMaxScale in interface FLayer
    
    Parameters:
    
    maxScale - the scale > 0, -1 if not defined
    
    See Also:
    
    FLayer.getMaxScale()
  - isWithinScale
```
public boolean isWithinScale(double scale)
```
    Description copied from interface: FLayer
    
    Returns if the value of scale argument is within the maximum and minimum scale of this layer.
    
    Specified by:
    
    isWithinScale in interface FLayer
    
    Parameters:
    
    scale - the scale > 0
    
    Returns:
    
    true if the scale argument is within the range of scales of this layer; false otherwise
    
    See Also:
    
    FLayer.setMinScale(double), FLayer.setMaxScale(double)
  - setEditing
```
public void setEditing(boolean b)
                throws StartEditionLayerException
```
    Description copied from interface: FLayer
    
    Do nothing.
    
    Specified by:
    
    setEditing in interface FLayer
    
    Throws:
    
    StartEditionLayerException
  - callEditionChanged
```
protected void callEditionChanged(LayerEvent e)
```
    Called by some version of the method setEditing(boolean) overwritten. Notifies all listeners associated to this layer, that its edition state has changed.
    
    Parameters:
    
    e - a layer event with the name of the property that has changed
    
    See Also:
    
    setEditing(boolean)
  - isEditing
```
public boolean isEditing()
```
    Description copied from interface: FLayer
    
    Returns if this layer is editable.
    
    One layer is editable if user can modify its information with graphical tools.
    
    Specified by:
    
    isEditing in interface FLayer
    
    Returns:
    
    true if this layer is editable; false otherwise
    
    See Also:
    
    FLayer.setEditing(boolean)
  - getTocImageIcon
```
public java.lang.String getTocImageIcon()
```
    Description copied from interface: FLayer
    
    Returns the image icon that will be shown in the TOC next to this layer.
    
    Specified by:
    
    getTocImageIcon in interface FLayer
    
    Returns:
    
    a String reference to the image icon, or null if there isn't any
  - isInTOC
```
public boolean isInTOC()
```
    Description copied from interface: FLayer
    
    Returns if this layer appears in the TOC.
    
    If doesn't appears, remains in the view and in the project.
    
    Specified by:
    
    isInTOC in interface FLayer
    
    Returns:
    
    true if this layer appears in the TOC; false otherwise
  - setInTOC
```
public void setInTOC(boolean b)
```
    Description copied from interface: FLayer
    
    Sets that this layer appears or not in the TOC.
    
    Specified by:
    
    setInTOC in interface FLayer
    
    Parameters:
    
    b - true if appears in the TOC; false otherwise
  - isAvailable
```
public boolean isAvailable()
```
    Description copied from interface: FLayer
    
    Returns the status of availability of this layer.
    
    One layer is available if the source of data is on-line.
    
    Specified by:
    
    isAvailable in interface FLayer
    
    Returns:
    
    true if the source of data is on-line; false otherwise
    
    See Also:
    
    FLayer.setAvailable(boolean), FLayer.isVisible()
  - setAvailable
```
public void setAvailable(boolean available)
```
    Description copied from interface: FLayer
    
    Changes the status of availability of this layer.
    
    One layer is available if the source of data is on-line.
    
    Specified by:
    
    setAvailable in interface FLayer
    
    Parameters:
    
    available - the boolean to be set
    
    See Also:
    
    FLayer.isAvailable()
  - reload
```
public void reload()
            throws ReloadLayerException
```
    Description copied from interface: FLayer
    
    Tries recover a layer of a possible error.
    
    If it has any problem during the load, marks the availability to false and throws an exception.
    
    Specified by:
    
    reload in interface FLayer
    
    Throws:
    
    ReloadLayerException - if it's thrown a ReadException or an IOException during the load of this layer.
    
    See Also:
    
    FLayer.load()
  - getFLayerStatus
```
public FLayerStatus getFLayerStatus()
```
    Description copied from interface: FLayer
    
    Returns the status of this layer.
    
    Specified by:
    
    getFLayerStatus in interface FLayer
    
    Returns:
    
    the status stored in a FLayerStatus object
    
    See Also:
    
    FLayer.setFLayerStatus(FLayerStatus)
  - setFLayerStatus
```
public void setFLayerStatus(FLayerStatus status)
```
    Description copied from interface: FLayer
    
    Sets the status of this layer.
    
    Specified by:
    
    setFLayerStatus in interface FLayer
    
    Parameters:
    
    status - information of the status for this layer
    
    See Also:
    
    FLayer.getFLayerStatus()
  - isOk
```
public boolean isOk()
```
    Description copied from interface: FLayer
    
    Returns if this layer hasn't got errors.
    
    Specified by:
    
    isOk in interface FLayer
    
    Returns:
    
    true if this layer hasn't got errors; false otherwise
  - getNumErrors
```
public int getNumErrors()
```
    Description copied from interface: FLayer
    
    Returns the number of errors which causes this layer to be in unavailable status.
    
    Specified by:
    
    getNumErrors in interface FLayer
    
    Returns:
    
    number of errors >= 0
    
    See Also:
    
    FLayer.getError(int), FLayer.getErrors()
  - getError
```
public java.lang.Throwable getError(int i)
```
    Description copied from interface: FLayer
    
    Returns the specified error.
    
    Specified by:
    
    getError in interface FLayer
    
    Parameters:
    
    i - index of the error >= 0 && < getNumErrors
    
    Returns:
    
    a singular error
    
    See Also:
    
    FLayer.getNumErrors(), FLayer.getErrors()
  - getErrors
```
public java.util.List<java.lang.Throwable> getErrors()
```
    Description copied from interface: FLayer
    
    Returns a list with all layer errors.
    
    Specified by:
    
    getErrors in interface FLayer
    
    Returns:
    
    an ArrayList with the errors
    
    See Also:
    
    FLayer.getError(int), FLayer.getNumErrors()
  - addError
```
public void addError(java.lang.Throwable exception)
```
    Description copied from interface: FLayer
    
    Adds an error reason that describes this layer's wrong status.
    
    Specified by:
    
    addError in interface FLayer
    
    Parameters:
    
    exception - a BaseException with the information of the error
    
    See Also:
    
    FLayer.getNumErrors(), FLayer.getError(int), FLayer.getErrors()
  - setError
```
public void setError(java.lang.Throwable ex)
```
    Specified by:
    
    setError in interface FLayer
  - visibleRequired
```
public boolean visibleRequired()
```
    Description copied from interface: FLayer
    
    Returns true if this layer has the visible status enabled.
    
    Specified by:
    
    visibleRequired in interface FLayer
    
    Returns:
    
    true if visible this layer has the visible status enabled, otherwise false
    
    See Also:
    
    FLayer.isVisible(), FLayer.setVisible(boolean)
  - getInfoString
```
public java.lang.String getInfoString()
```
    Description copied from interface: FLayer
    
    Returns an string with the information of this layer.
    
    Specified by:
    
    getInfoString in interface FLayer
    
    Returns:
    
    the string that is to be this component's information
  - isWritable
```
public boolean isWritable()
```
    Description copied from interface: FLayer
    
    Returns the writing status of this layer.
    
    One layer is writable if there is a writing driver for this layer.
    
    Specified by:
    
    isWritable in interface FLayer
    
    Returns:
    
    true if there is a writing driver for this layer; false otherwise
  - cloneLayer
```
public FLayer cloneLayer()
                  throws java.lang.Exception
```
    Description copied from interface: FLayer
    
    This method can be used to have a fast cloned layer.
    
    The implementations should take care of not recreate this layer. Instead of this, is better to use the same source (driver) and deepclone the legend. Exception: the labels aren't deepcloned to avoid memory consumption.
    
    Note: Labels are memory consuming to speed up layers like PostGIS and so on.
    
    Specified by:
    
    cloneLayer in interface FLayer
    
    Returns:
    
    a layer that is a clonation of this layer
    
    Throws:
    
    java.lang.Exception - any exception produced during the cloning of this layer.
  - getTocStatusImage
```
public java.awt.Image getTocStatusImage()
```
    Description copied from interface: FLayer
    
    Returns the image icon that will be shown in the TOC next to this layer, according its status.
    
    Specified by:
    
    getTocStatusImage in interface FLayer
    
    Returns:
    
    the image
  - setTocStatusImage
```
public void setTocStatusImage(java.awt.Image tocStatusImage)
```
    Inserts the image icon that will be shown in the TOC next to this layer, according its status.
    
    Parameters:
    
    tocStatusImage - the image
    
    See Also:
    
    getTocStatusImage()
  - newComposedLayer
```
public ComposedLayer newComposedLayer()
```
    Description copied from interface: FLayer
    
    Returns a new instance of ComposedLayer.
    
    This allows make a single draw for a group of layers with the same source.
    
    If this operation isn't applicable for this kind of layer, this method returns null.
    
    By default this operation is not supported.
    
    Specified by:
    
    newComposedLayer in interface FLayer
    
    Returns:
    
    a new composed layer or null if not supported
    
    See Also:
    
    ComposedLayer
  - allowLinks
```
public boolean allowLinks()
```
    Description copied from interface: FLayer
    
    Alwais return false
    
    Specified by:
    
    allowLinks in interface FLayer
    
    Returns:
    
    false
  - getLinkProperties
```
public AbstractLinkProperties getLinkProperties()
```
    Description copied from interface: FLayer
    
    Alwais return null.
    
    Specified by:
    
    getLinkProperties in interface FLayer
    
    Returns:
    
    null
  - getLink
```
public java.net.URI[] getLink(java.awt.geom.Point2D point,
                              double tolerance)
                       throws ReadException
```
    Description copied from interface: FLayer
    
    alwais return null
    
    Specified by:
    
    getLink in interface FLayer
    
    Returns:
    
    null
    
    Throws:
    
    ReadException
  - addLegendListener
```
public void addLegendListener(LegendListener listener)
```
  - callLegendChanged
```
protected void callLegendChanged(LegendChangedEvent e)
```
    Parameters:
    
    e -
    
    See Also:
    
    LayerChangeSupport.callLegendChanged(LegendChangedEvent)
  - removeLegendListener
```
public void removeLegendListener(LegendListener listener)
```
    Parameters:
    
    listener -
    
    See Also:
    
    LayerChangeSupport.removeLayerListener(LegendListener)
  - getClassName
```
public java.lang.String getClassName()
```
  - delegate
```
public void delegate(DynObject dynObject)
```
    Specified by:
    
    delegate in interface DynObject
  - getDynClass
```
public DynClass getDynClass()
```
    Specified by:
    
    getDynClass in interface DynObject
  - getDynValue
```
public java.lang.Object getDynValue(java.lang.String name)
                             throws DynFieldNotFoundException
```
    Specified by:
    
    getDynValue in interface DynObject
    
    Throws:
    
    DynFieldNotFoundException
  - hasDynValue
```
public boolean hasDynValue(java.lang.String name)
```
    Specified by:
    
    hasDynValue in interface DynObject
  - implement
```
public void implement(DynClass dynClass)
```
    Specified by:
    
    implement in interface DynObject
  - invokeDynMethod
```
public java.lang.Object invokeDynMethod(int code,
                                        java.lang.Object[] args)
                                 throws DynMethodException
```
    Specified by:
    
    invokeDynMethod in interface DynObject
    
    Throws:
    
    DynMethodException
  - invokeDynMethod
```
public java.lang.Object invokeDynMethod(java.lang.String name,
                                        java.lang.Object[] args)
                                 throws DynMethodException
```
    Specified by:
    
    invokeDynMethod in interface DynObject
    
    Throws:
    
    DynMethodException
  - setDynValue
```
public void setDynValue(java.lang.String name,
                        java.lang.Object value)
                 throws DynFieldNotFoundException
```
    Specified by:
    
    setDynValue in interface DynObject
    
    Throws:
    
    DynFieldNotFoundException
  - getDrawVersion
```
public long getDrawVersion()
```
    Specified by:
    
    getDrawVersion in interface FLayer
  - updateDrawVersion
```
protected void updateDrawVersion()
```
  - updateDrawVersion
```
protected void updateDrawVersion(boolean fireEvents)
```
  - hasChangedForDrawing
```
public boolean hasChangedForDrawing(long value)
```
  - activationChanged
```
public void activationChanged(LayerEvent e)
```
    Description copied from interface: LayerListener
    
    Called when the activation of a layer has changed.
    
    Specified by:
    
    activationChanged in interface LayerListener
    
    Parameters:
    
    e - an activation changed layer event object
  - drawValueChanged
```
public void drawValueChanged(LayerEvent e)
```
    Description copied from interface: LayerListener
    
    Called when a draw value of a layer has changed.
    
    Specified by:
    
    drawValueChanged in interface LayerListener
    
    Parameters:
    
    e - an edition changed layer event object
  - editionChanged
```
public void editionChanged(LayerEvent e)
```
    Description copied from interface: LayerListener
    
    Called when the edition of a layer has changed.
    
    Specified by:
    
    editionChanged in interface LayerListener
    
    Parameters:
    
    e - an edition changed layer event object
  - nameChanged
```
public void nameChanged(LayerEvent e)
```
    Description copied from interface: LayerListener
    
    Called when the name of a layer has changed.
    
    Specified by:
    
    nameChanged in interface LayerListener
    
    Parameters:
    
    e - a name changed layer event object
  - visibilityChanged
```
public void visibilityChanged(LayerEvent e)
```
    Description copied from interface: LayerListener
    
    Called when the visibility of a layer has changed.
    
    Specified by:
    
    visibilityChanged in interface LayerListener
    
    Parameters:
    
    e - a visibility changed layer event object
  - 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
  - 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
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface DynObject
  - getMetadataName
```
public java.lang.String getMetadataName()
                                 throws MetadataException
```
    Description copied from interface: Metadata
    
    Returns the name of the Metadata, which allows to identify the type in the Metadata registry.
    
    Specified by:
    
    getMetadataName in interface Metadata
    
    Returns:
    
    the Metadata name
    
    Throws:
    
    MetadataException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hidesThisArea
```
public boolean hidesThisArea(Envelope area)
```
    Specified by:
    
    hidesThisArea in interface FLayerHidesArea
  - isTemporary
```
public boolean isTemporary()
```
    Specified by:
    
    isTemporary in interface FLayer
  - setTemporary
```
public void setTemporary(boolean temporary)
```
    Specified by:
    
    setTemporary in interface FLayer
  - getDefaultTolerance
```
public int getDefaultTolerance()
```
    Description copied from interface: FLayer
    
    Returns layer tolerance in pixels
    
    Specified by:
    
    getDefaultTolerance in interface FLayer
    
    Returns:
    
    layer tolerance
  - invalidate
```
public void invalidate()
```
    Specified by:
    
    invalidate in interface FLayer

Class FLyrDefault

Nested Class Summary

Field Summary

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

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 org.gvsig.fmap.mapcontext.layers.FLayer

Methods inherited from interface org.gvsig.metadata.Metadata

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

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

Field Detail

layerListeners

metadataContainer

drawVersion

properties

Constructor Detail

FLyrDefault

FLyrDefault

Method Detail

getProperty

setProperty

getExtendedProperties

setActive

isActive

setName

getName

load

setVisible

isVisible

getParentLayer

setParentLayer

setProjection

getProjection

reProject

getTransparency

setTransparency

getMapContext

addLayerListener

getLayerListeners

removeLayerListener

setCoordTrans

getCoordTrans

wakeUp

getMinScale

getMaxScale

setMinScale

setMaxScale

isWithinScale

setEditing

callEditionChanged

isEditing

getTocImageIcon

isInTOC

setInTOC

isAvailable

setAvailable

reload

getFLayerStatus

setFLayerStatus

isOk

getNumErrors

getError

getErrors

addError

setError

visibleRequired

getInfoString

isWritable

cloneLayer

getTocStatusImage

setTocStatusImage

newComposedLayer

allowLinks

getLinkProperties

getLink

addLegendListener

callLegendChanged

removeLegendListener