VectorLayer (JMap 7.0 Kathmandu API Documentation)

java.lang.Object
- com.kheops.jmap.metadata.LocalizedObject
- - com.kheops.jmap.client.layers.Layer
  - - com.kheops.jmap.client.layers.VectorLayer

All Implemented Interfaces:

JMapEventDispatcher, ILayer, IVectorLayer, LayerConstants, LayerNode, Shareable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Layer>

Direct Known Subclasses:

PersonalVectorLayer
```
public class VectorLayer
extends Layer
implements IVectorLayer, Shareable
```
A class that represents a layer of vector map elements. Map elements are instances of K2DElement. A vector layer has a tile set (TileSet) that actually contains the elements grouped together in tiles.

See Also:

TileSet, K2DElement, LayerManager, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Attribute[]`	`attribMetaData`
`protected java.lang.String`	`authorColumnName`
`protected java.lang.String`	`creationTimeColumnName`
`protected java.util.Vector<DisplayFilter>`	`displayFilters`
`protected java.util.List<FormInfo>`	`forms`
`protected Hyperlink[]`	`hyperlinks`
`protected java.lang.String`	`idAttributeName`
`protected java.lang.String`	`keyAttributeName`
`protected LabelsConfiguration`	`labelsConfig`
`protected java.lang.String`	`modificationTimeColumnName`
`protected MouseOverConfiguration`	`mouseOverConfiguration`
`protected Point`	`offset` The offset is an instance of Point.
`protected java.util.Vector<QueryFilter>`	`queryFilters`
`protected boolean`	`queryFiltersChanged` Deprecated. use `invalidate()` instead.
`int`	`requestMode`
`protected java.util.Vector<K2DElement>`	`selection`
`protected java.util.List<SubFormInfo>`	`subForms`
`protected Thematic[]`	`thematics`
`protected TileSet`	`tileSet`

Fields inherited from class com.kheops.jmap.client.layers.Layer
DEFAULT_DRAW_STATE, description, DRAW_OPTIONS_SYNC, drawState, dynamicRefresh, elementFactory, elementType, eventDispatcher, id, infoReportConfig, lastUpdateTime, LAYER_ID_HIGHLIGHT, LAYER_ID_INITIAL_VIEW_BOUNDS, LAYER_ID_LABELS, LAYER_ID_MARKERS, LAYER_ID_SYS_DRAWINGS, LAYER_ID_TMP_DRAWINGS, LAYER_ID_USER_DRAWINGS, LAYER_ID_USER_LABELS, layerProperties, maximumVisibleScale, metadataUrl, minimumVisibleScale, name, precisionModel, readOnlyProperties, styleManager, verbose

Fields inherited from interface com.kheops.jmap.client.layers.IVectorLayer
serialVersionUID

Constructor Summary

Constructors
Constructor and Description
`VectorLayer(int id, int geometryType, int elementType, java.lang.String name, boolean isVisible)` Deprecated.
`VectorLayer(int id, int geometryType, int elementType, java.lang.String name, boolean isVisible, int col, int row, Rectangle extent)` Deprecated.
`VectorLayer(int id, java.lang.String name, int elementType)` Creates a new VectorLayer using the specified parameters. The new layer will be configured with one infinite tile.
`VectorLayer(int id, java.lang.String name, int elementType, int col, int row, Rectangle extent)` Creates a new VectorLayer using the specified parameters.
`VectorLayer(VectorLayerInfo layerInfo)` Creates a new VectorLayer using the specified VectorLayerInfo.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDisplayFilter(DisplayFilter filter)` Adds a new filter to the list of display filters for the layer.
`void`	`addElement(K2DElement elem)` Adds the specified element to the layer and then fires a LayerElementsAddedEvent.
`void`	`addElement(K2DElement element, boolean fireEvent)` Adds the specified element (K2DElement) to the layer.
`void`	`addElements(K2DElement[] elements)` Adds the specified elements to the layer and then fires a LayerElementsAddedEvent.
`void`	`addElements(K2DElement[] elements, boolean fireEvent)` Adds the specified elements (K2DElement) to the layer.
`void`	`addQueryFilter(QueryFilter filter)` Adds a new query filter to the list of filters for the layer.
`void`	`addThematic(Thematic thematic)` Adds a thematic to this layer.
`void`	`addToSelection(java.util.Collection<K2DElement> elems)` Adds the specified elements to the selection of the layer.
`void`	`addToSelection(java.util.Collection<K2DElement> elems, boolean fireEvent)` Adds the specified elements to the selection of the layer.
`void`	`addToSelection(K2DElement elem)` Adds the specified element to the selection of the layer.
`void`	`addToSelection(K2DElement elem, boolean fireEvent)` Adds the specified element to the selection of the layer.
`boolean`	`alwayDrawSelection()` Returns whether or not the layer selection will always be drawn. If enabled, the selection will be drawn at any scale, even if the layer is not visible.
`boolean`	`applyFilters(K2DElement elem)` Returns whether or not the specified element was accepted by the current display filters configured in the layer.
`void`	`bringForward(K2DElement[] elements)` Moves the specified elements one z order position up.
`void`	`bringToFront(K2DElement[] elements)` Moves the specified elements to the highest z order position.
`void`	`clearSelection()` Empties the selection of the layer.
`java.lang.Object`	`clone()` Returns a deep clone of the current LayerInfo instance.
`protected void`	`cloneImpl(IVectorLayer newLayer, boolean sharedGeometry)` Share method implementation.
`void`	`close()` Clears all elements in the layer and removes all configured listeners.
`Rectangle`	`computeDisplayBounds(ViewState viewState, java.util.Collection<K2DElement> elements, boolean onlyIfVisible)`
`Rectangle`	`computeExtent(java.util.Collection<K2DElement> elements)`
`Rectangle`	`computeZoomedDisplayBounds(ViewState viewState, java.util.Collection<K2DElement> elements, boolean onlyIfVisible)`
`void`	`draw(GraphicsRef gr, ViewState viewState, OrientedRectangle region, double scale, DrawParameters drawParameters)` Draws all elements contained in the specified region to the specified graphics object and applying the specified transformation.
`protected void`	`draw(GraphicsRef gr, ViewState viewState, java.util.Vector<Tile> tileVec, OrientedRectangle region, double scale, DrawParameters drawParameters)` Draws all elements contained in the specified tiles and intersecting with the specified region to the specified graphics object and applying the specified transformation.
`protected void`	`draw(GraphicsRef gr, ViewState viewState, java.util.Vector<Tile> tileVec, OrientedRectangle region, double scale, int drawOptions)` Deprecated. use `draw(GraphicsRef, ViewState, Vector, OrientedRectangle, double, DrawParameters)` instead.
`void`	`drawGrid(GraphicsRef gr, K2DTransform t)` Draws a grid representing the tiles configuration of the layer.
`protected void`	`drawImpl(GraphicsRef gr, ViewState viewState, java.util.Vector<Tile> tileVec, OrientedRectangle region, double scale, DrawParameters drawParameters)`
`protected void`	`drawImpl(GraphicsRef gr, ViewState viewState, java.util.Vector<Tile> tileVec, OrientedRectangle region, double scale, int drawOptions)` Deprecated. use `drawImpl(GraphicsRef, ViewState, Vector, OrientedRectangle, double, DrawParameters)` instead.
`void`	`drawSelection(GraphicsRef gr, ViewState viewState, double scale)` Draws the selected elements of the layer.
`void`	`enableThematic(int thematicIx, boolean isEnabled)` Enables or disables a thematic configured in the current layer.
`void`	`enableThematic(Thematic thematic, boolean isEnabled)` Enables or disables a thematic configured in the current layer.
`void`	`enableThematics(boolean isEnabled)` Enables or disables all thematics configured in the current layer.
`protected void`	`fireAttributeMetadataChangedEvent(LayerAttributeMetadataChangedEvent event)`
`protected void`	`fireDataRequestedEvent(OrientedRectangle region, boolean sync)`
`protected void`	`fireDataRequestedEvent(java.util.Vector<Tile> reqTiles, boolean sync)`
`protected void`	`fireDisplayFilterChangedEvent(LayerDisplayFilterChangedEvent event)`
`protected void`	`fireElementRemovedEvent(K2DElement[] elements)`
`protected void`	`fireElementsAddedEvent(K2DElement[] elements)`
`void`	`fireElementsChangedEvent(K2DElement[] elements)`
`protected void`	`fireQueryfilterChangedEvent(LayerQueryFilterChangedEvent event)`
`protected void`	`fireSelChangedEvent(K2DElement elem, int operType)`
`protected void`	`fireSelChangedEvent(java.util.Vector<K2DElement> elems, int operType)`
`Acl`	`getAcl()`
`K2DElement[]`	`getAllElements()` Deprecated. use getElements() instead
`int`	`getAttributeIndex(Attribute attrib)` Returns the index of the specified attribute in the current metadata attributes array.
`Attribute[]`	`getAttributeMetaData()` Returns bound attributes on this layer.
`ClusterDisplayStrategyInfo`	`getClusterDisplayStrategyInfo()`
`Style`	`getDefaultSelectionStyle()` Gets the default selection style
`DisplayFilter[]`	`getDisplayFilters()`
`Rectangle`	`getDisplaySelectedBounds(View view)` Deprecated. use `getDisplaySelectedBounds(ViewState)`
`Rectangle`	`getDisplaySelectedBounds(ViewState viewState)` Returns the DC bounding box of the current selection of the layer.
`Rectangle`	`getDisplaySelectedBounds(ViewState viewState, boolean zoomed)` Returns the DC bounding box of the current selection of the layer.
`VectorDisplayStrategyManager`	`getDisplayStrategyManager()`
`K2DElement`	`getElement(int tileIx, int elemIx)` Returns the element contained in the specified tile at the specified position.
`K2DElement`	`getElement(long id)` Returns the element having the specified id or null if it does not exist.
`K2DElement`	`getElementAtPoint(Point WCCoord, View view, boolean onlyIfVisible)` Deprecated. use `getElementAtPoint(Point, ViewState, boolean)`
`K2DElement`	`getElementAtPoint(Point WCCoord, ViewState viewState, boolean onlyIfVisible)` Returns the first element found at the specified point in world coordinate system or null if none is found.
`int`	`getElementCount()` Returns the number of elements contained by the layer.
`java.lang.String`	`getElementLabel(K2DElement elem)` Returns the label string from the layer label column for the specified element.
`java.lang.String`	`getElementLabel(K2DElement elem, Project project)` Returns the label string from the layer label column for the specified element.
`java.util.Collection<K2DElement>`	`getElements()`
`java.util.Enumeration<K2DElement>`	`getElementsAtPoint(Point WCCoord, View view, boolean onlyIfVisible)` Deprecated. use `getElementsAtPoint(Point, ViewState, boolean)`
`java.util.Enumeration<K2DElement>`	`getElementsAtPoint(Point WCCoord, ViewState viewState, boolean onlyIfVisible)` Returns all the elements found at the specified point in world coordinate system or null if none is found.
`java.util.Enumeration<K2DElement>`	`getElementsInCircle(Point WCCoord, View view, double radius, boolean onlyIfVisible)` Deprecated. use `getElementsInCircle(Point, ViewState, double, boolean)`
`java.util.Enumeration<K2DElement>`	`getElementsInCircle(Point WCCoord, ViewState viewState, double radius, boolean onlyIfVisible)` Returns the enumeration of elements that are contained completely or partially in the specified world coordinate circle.
`java.util.Enumeration<K2DElement>`	`getElementsInSurface(Surface wcSurface, View view, boolean onlyIfVisible)` Deprecated. use `getElementsInSurface(Surface, ViewState, boolean)`
`java.util.Enumeration<K2DElement>`	`getElementsInSurface(Surface wcSurface, ViewState viewState, boolean onlyIfVisible)` Returns the enumeration of elements that are contained copmpletely or partially in the specified world coordinate surface.
`java.util.Enumeration<K2DElement>`	`getElementsOnLine(LineString wcLine, View view, boolean onlyIfVisible)` Deprecated. use `getElementsOnLine(LineString, ViewState, boolean)`
`java.util.Enumeration<K2DElement>`	`getElementsOnLine(LineString wcLine, ViewState viewState, boolean onlyIfVisible)` Returns the enumeration of elements that are contained completely or partially on the specified world coordinate line.
`Thematic[]`	`getEnabledThematics()` Return an array of enabled thematic (displayed thematic).
`Rectangle`	`getExtent()` Returns a clone of the layer extent.
`AbstractFormInfo`	`getForm(int id)` Returns the form or subfom with the specified id.
`java.util.List<FormInfo>`	`getForms()`
`HeatMapDisplayStrategyInfo`	`getHeatMapDisplayStrategyInfo()`
`Hyperlink[]`	`getHyperlinks()`
`LabelsConfiguration`	`getLabelsConfig()` Returns the labels configuration for this layer.
`MouseOverConfiguration`	`getMouseOverConfiguration()`
`Point`	`getOffset()` Gets the offset
`K2DTransform`	`getOffsetTransform(K2DTransform t)` Gets the offset transformation matrix
`QueryFilter[]`	`getQueryFilters()`
`int`	`getRequestMode()` Returns the request mode for this layer.
`K2DElement[]`	`getSelectedElements()` Gets the selected elements
`Rectangle`	`getSelectedExtent()` Returns the extent created from selected element geometries in the current layer.
`java.util.Collection<K2DElement>`	`getSelection()` Gets the selected elements
`int`	`getSelectionSize()` Gets the selection count
`Style`	`getSelectionStyle()` Returns the default selection style object associated with the layer. Note: If this layer has more than one style (depending on the view scale), the lowest scale selection style is returned. If the layer is editable, the default edition style of the layer will be returned.
`Style`	`getSelectionStyle(double scale)` Returns the selection style object associated with the layer for the specified scale. If the layer is editable, the edition style of the layer corresponding to the specified scale will be returned.
`Style`	`getSelectionStyle(K2DElement elem, double scale)` Returns the current selection style for the specified element.
`Style`	`getStyle(K2DElement elem, double scale)` Returns the current style for the specified element.
`java.util.List<SubFormInfo>`	`getSubForms()`
`Thematic`	`getThematic(int id)`
`Thematic[]`	`getThematics()` Return all thematics added to this layer.
`TileSet`	`getTiles()` Returns the TileSet object associated with the layer.
`LockManager`	`getUpdateLock()`
`boolean`	`getUseClientCache()` Gets the useClientCache boolean flag
`boolean`	`hasElementsInSurface(Surface wcSurface, ViewState viewState, boolean onlyIfVisible)` Returns whether at least one element is contained completely or partially in the specified world coordinate surface.
`void`	`invalidate()` Invalidates the current layer.
`void`	`invertSelection()` Inverts the selection on this layer.
`boolean`	`isEditable()` Returns whether or not this layer is editable.
`boolean`	`isEditing()`
`void`	`loadData(Geometry bounds, boolean sync)` This method automatically loads the data tiles intersecting with the specified geometry.
`void`	`prepareSyncData(GraphicsRef gr, ViewState viewState, java.util.Vector<Tile> tileVec, OrientedRectangle region)`
`void`	`removeAllDisplayFilters()` Remove all display filters from the layer
`void`	`removeAllElements()` Removes all the elements from this layer and fires an fireElementRemovedEvent event.
`void`	`removeAllElements(boolean fireEvent)` Removes all the elements from this layer.
`void`	`removeAllQueryFilters()` Remove all query filters from the layer
`void`	`removeDisplayFilter(DisplayFilter filter)` Removes the specified filter from the list of display filters for the layer.
`boolean`	`removeElement(K2DElement elem)` Removes the specified element (K2DElement) from the layer.
`boolean`	`removeElement(K2DElement elem, boolean fireEvent)` Removes the specified element (K2DElement) from the layer.
`boolean`	`removeElement(long elemId)` Removes the element that has the specified id from the layer.
`boolean`	`removeElement(long elemId, boolean fireEvent)` Removes the element that has the specified id from the layer.
`boolean`	`removeElements(K2DElement[] aElements)` Removes the specified elements from the layer.
`boolean`	`removeElements(K2DElement[] aElements, boolean fireEvent)` Removes the specified elements from the layer.
`void`	`removeFromSelection(K2DElement elem)` Removes the specified element from the selection of the layer.
`void`	`removeFromSelection(K2DElement elem, boolean fireEvent)` Removes the specified element from the selection of the layer.
`void`	`removeFromSelection(java.util.Vector<K2DElement> elements)` Removes the specified elements from the selection of the layer.
`void`	`removeFromSelection(java.util.Vector<K2DElement> elements, boolean fireEvent)` Removes the specified elements from the selection of the layer.
`void`	`removeQueryFilter(QueryFilter filter)` Removes the specified query filter from the list of filters for the layer.
`void`	`removeThematic(Thematic thematic)` Removes a thematic from this layer.
`void`	`requestUnsyncData(GraphicsRef gr, ViewState viewState, java.util.Vector<Tile> reqTiles, OrientedRectangle region)`
`void`	`selectAll()`
`void`	`sendBackward(K2DElement[] elements)` Moves the specified elements one z order position down.
`void`	`sendToBack(K2DElement[] elements)` Moves the specified elements to the lowest z order position.
`void`	`setAcl(Acl acl)`
`void`	`setAlwayDrawSelection(boolean isTrue)` Enables layer selection to always be drawn. If enabled, the selection will be drawn at any scale, even if the layer is not visible.
`void`	`setAttributeMetaData(Attribute[] attribMetaData)` Replaces the current attribute array of the layer with the one specified.
`void`	`setClusterDisplayStrategyInfo(ClusterDisplayStrategyInfo clusterDisplayStrategyInfo)`
`void`	`setEditable(boolean editable)` Adds or removes edition permissions on the layer: `Permission.ADD_LAYER_ELEMENT`, `Permission.EDIT_LAYER_ELEMENT`, `Permission.DELETE_LAYER_ELEMENT` and `Permission.EDIT_LAYER_ATTRIBUTE_VALUES`.
`void`	`setEditing(boolean flag)`
`void`	`setForms(java.util.List<FormInfo> forms)`
`void`	`setHeatMapDisplayStrategyInfo(HeatMapDisplayStrategyInfo heatMapDisplayStrategyInfo)`
`void`	`setHyperlinks(Hyperlink[] hyperlinks)`
`void`	`setLabelsConfig(LabelsConfiguration labelsConfig)` Sets the labels configuration for this layer.
`void`	`setLastTransform(K2DTransform t, GraphicsRef gr)` Deprecated. use `Layer.revalidate(K2DTransform)` instead
`void`	`setMouseOverConfiguration(MouseOverConfiguration mouseOverConfiguration)`
`void`	`setOffset(Point offset)` Sets the Offset
`void`	`setRequestMode(int requestMode)` Sets the request mode for this layer.
`void`	`setSubForms(java.util.List<SubFormInfo> subForms)`
`void`	`setThematics(Thematic[] thematics)` Sets all thematics of this layer.
`void`	`setTiles(TileSet tileSet)` Sets the tile set for this layer.
`void`	`setUseClientCache(boolean flag)` Sets useClientCache boolean flag
`Shareable`	`share()` Creates a deep copy of the current layer, excluding geometries in elements of the layer which remain the same instances in all shared layers.
`void`	`swapThematic(Thematic thematic, int index)` Moves a thematic to a specific position in the layer's thematics.
`VectorLayerInfo`	`toLayerInfo()`
`void`	`unselectElement(K2DElement elem)` Deprecated. Use removeFromSelection(K2DElement) instead.
`void`	`unselectElement(K2DElement elem, boolean fireEvent)` Deprecated. Use removeFromSelection(K2DElement, boolean) instead.
`void`	`update(ILayer layer)`
`void`	`validateTiling(K2DElement[] elements)`

Methods inherited from class com.kheops.jmap.client.layers.Layer
addLayerEventListener, clone, compareTo, dispatchEvent, draw, drawGrid, fireLayerPropertyBeforeChangeEvent, fireLayerPropertyChangedEvent, fireLayerReceivedDataEvent, fireRefreshRequestEvent, fireStyleChangedEvent, getDescription, getDescription, getDynamicRefresh, getElementFactory, getElementType, getId, getInfoReportConfig, getLastUpdateTime, getLayerProperties, getMaximumVisibleScale, getMetadataUrl, getMinimumVisibleScale, getName, getName, getNextSystemLayerId, getNextUserLayerId, getPrecisionModel, getReadOnlyProperties, getStyle, getStyle, getStyleManager, getVerbose, initEventDispatcher, isDrawable, isDynamic, isIncludeInContext, isIndex, isListed, isLocal, isNamed, isPersonalLayerId, isProjectLayerId, isQueriable, isReservedLayerId, isSelectable, isSystemLayerId, isUserLayerId, isVisible, removeLayerEventListener, removeTranslationsOtherThan, revalidate, setDescription, setDescription, setDrawGrid, setDynamicRefresh, setElementFactory, setElementType, setId, setIncludeInContext, setIndex, setInfoReportConfig, setLastUpdateTime, setLayerProperties, setListed, setLocal, setMaximumVisibleScale, setMetadataUrl, setMinimumVisibleScale, setName, setName, setPrecisionModel, setProperty, setQueriable, setReadOnlyProperties, setReadOnlyProperty, setSelectable, setStyle, setStyle, setStyleManager, setVerbose, setVisible, setVisible, toString

Methods inherited from class com.kheops.jmap.metadata.LocalizedObject
getAvailableLocales, getTranslation, isTranslationExists, setTranslation, updateTranslations

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

Methods inherited from interface com.kheops.jmap.client.layers.IVectorLayer
getAuthorColumnName, getCreationTimeColumnName, getDatabaseConfigInfo, getElementFactory, getIdAttributeName, getKeyAttributeName, getModificationTimeColumnName, setAuthorColumnName, setCreationTimeColumnName, setDatabaseConfigInfo, setElementFactory, setIdAttributeName, setKeyAttributeName, setModificationTimeColumnName

Methods inherited from interface com.kheops.jmap.client.layers.ILayer
getDescription, getDescription, getDynamicRefresh, getElementType, getId, getInfoReportConfig, getLastUpdateTime, getLayerProperties, getMaximumVisibleScale, getMetadataUrl, getMinimumVisibleScale, getName, getName, getReadOnlyProperties, getStyleManager, isDynamic, isIndex, isListed, isLocal, isSelectable, isVisible, setDescription, setDescription, setDynamicRefresh, setElementType, setId, setIndex, setInfoReportConfig, setLastUpdateTime, setLayerProperties, setListed, setLocal, setMaximumVisibleScale, setMetadataUrl, setMinimumVisibleScale, setName, setName, setProperty, setReadOnlyProperties, setReadOnlyProperty, setSelectable, setStyleManager, setVisible

- Field Detail
  - displayFilters
```
protected java.util.Vector<DisplayFilter> displayFilters
```
  - queryFilters
```
protected java.util.Vector<QueryFilter> queryFilters
```
  - tileSet
```
protected TileSet tileSet
```
  - offset
```
protected Point offset
```
    The offset is an instance of Point. Each element of the layer will be translated by the amount contained in the offset. It is used to keep double precision coordinates for the elements while using floats.
  - attribMetaData
```
protected Attribute[] attribMetaData
```
  - mouseOverConfiguration
```
protected MouseOverConfiguration mouseOverConfiguration
```
  - labelsConfig
```
protected LabelsConfiguration labelsConfig
```
  - hyperlinks
```
protected Hyperlink[] hyperlinks
```
  - thematics
```
protected Thematic[] thematics
```
  - selection
```
protected java.util.Vector<K2DElement> selection
```
  - requestMode
```
public int requestMode
```
  - queryFiltersChanged
```
@Deprecated
protected boolean queryFiltersChanged
```
    Deprecated. use invalidate() instead.
  - forms
```
protected java.util.List<FormInfo> forms
```
  - subForms
```
protected java.util.List<SubFormInfo> subForms
```
  - idAttributeName
```
protected java.lang.String idAttributeName
```
  - keyAttributeName
```
protected java.lang.String keyAttributeName
```
  - creationTimeColumnName
```
protected java.lang.String creationTimeColumnName
```
  - modificationTimeColumnName
```
protected java.lang.String modificationTimeColumnName
```
  - authorColumnName
```
protected java.lang.String authorColumnName
```
- Constructor Detail
  - VectorLayer
```
public VectorLayer(VectorLayerInfo layerInfo)
```
    Creates a new VectorLayer using the specified VectorLayerInfo.
    
    Parameters:
    
    layerInfo - the new layer configuration.
  - VectorLayer
```
@Deprecated
public VectorLayer(int id,
                               int geometryType,
                               int elementType,
                               java.lang.String name,
                               boolean isVisible)
```
    Deprecated.
    
    Creates a new VectorLayer using the specified parameters.
    The new layer will be configured with one infinite tile.
    
    Parameters:
    
    id - the id of the new layer.
    
    geometryType - the geometry type.
    
    elementType - the element type.
    
    name - the name.
    
    isVisible - whether or not this layer is visible.
  - VectorLayer
```
public VectorLayer(int id,
                   java.lang.String name,
                   int elementType)
```
    Creates a new VectorLayer using the specified parameters.
    The new layer will be configured with one infinite tile.
    
    Parameters:
    
    id - the id of the new layer.
    
    name - the name.
    
    elementType - the element type.
    
    See Also:
    
    ElementTypes
  - VectorLayer
```
@Deprecated
public VectorLayer(int id,
                               int geometryType,
                               int elementType,
                               java.lang.String name,
                               boolean isVisible,
                               int col,
                               int row,
                               Rectangle extent)
```
    Deprecated.
    
    Creates a new VectorLayer using the specified parameters.
    
    Parameters:
    
    id - the id of the new layer.
    
    geometryType - the geometry type.
    
    elementType - the element type.
    
    name - the name.
    
    isVisible - whether or not this layer is visible.
    
    col - the number of columns in the tiles grid.
    
    row - the number of rows in the tiles grid.
    
    extent - the layer extent.
  - VectorLayer
```
public VectorLayer(int id,
                   java.lang.String name,
                   int elementType,
                   int col,
                   int row,
                   Rectangle extent)
```
    Creates a new VectorLayer using the specified parameters.
    
    Parameters:
    
    id - the id of the new layer.
    
    name - the name.
    
    elementType - the element type.
    
    col - the number of columns in the tiles grid.
    
    row - the number of rows in the tiles grid.
    
    extent - the layer extent.
    
    See Also:
    
    ElementTypes
- Method Detail
  - getAttributeMetaData
```
public Attribute[] getAttributeMetaData()
```
    Returns bound attributes on this layer.
    
    Specified by:
    
    getAttributeMetaData in interface IVectorLayer
    
    Returns:
    
    an attribute of bound attributes. If there is no bound attribute, an empty non-null array is returned.
  - getAttributeIndex
```
public int getAttributeIndex(Attribute attrib)
```
    Returns the index of the specified attribute in the current metadata attributes array.
    
    Parameters:
    
    attrib - the attribute to search in the metadata attributes.
    
    Returns:
    
    the index of the specified attribute, or -1 if the attribute was not found.
  - setAttributeMetaData
```
public void setAttributeMetaData(Attribute[] attribMetaData)
```
    Replaces the current attribute array of the layer with the one specified.
    
    Specified by:
    
    setAttributeMetaData in interface IVectorLayer
    
    Parameters:
    
    attribMetaData - the new attribute table of the layer
  - getTiles
```
public TileSet getTiles()
```
    Returns the TileSet object associated with the layer.
    
    Specified by:
    
    getTiles in interface IVectorLayer
    
    Returns:
    
    the tile set of the layer
    
    See Also:
    
    TileSet
  - getUpdateLock
```
public LockManager getUpdateLock()
```
  - setTiles
```
public void setTiles(TileSet tileSet)
```
    Sets the tile set for this layer.
    
    Specified by:
    
    setTiles in interface IVectorLayer
    
    Parameters:
    
    tileSet - the tile set
    
    See Also:
    
    TileSet
  - getThematics
```
public Thematic[] getThematics()
```
    Return all thematics added to this layer. All thematics will be returned, including thematics which are not currently displayed.
    
    Specified by:
    
    getThematics in interface IVectorLayer
    
    Returns:
    
    all thematics added to this layer.
  - getThematic
```
public Thematic getThematic(int id)
```
    Parameters:
    
    id -
    
    Returns:
    
    Since:
    
    7.0
  - getEnabledThematics
```
public Thematic[] getEnabledThematics()
```
    Return an array of enabled thematic (displayed thematic).
    
    Returns:
    
    all enabled thematics in the layer.
  - setThematics
```
public void setThematics(Thematic[] thematics)
```
    Sets all thematics of this layer.
    
    Specified by:
    
    setThematics in interface IVectorLayer
    
    Parameters:
    
    thematics - the thematics array to set
  - enableThematic
```
public void enableThematic(int thematicIx,
                           boolean isEnabled)
```
    Enables or disables a thematic configured in the current layer.
    
    Parameters:
    
    thematicIx - the index of the thematic.
    
    isEnabled - whether or not to enable it.
  - enableThematic
```
public void enableThematic(Thematic thematic,
                           boolean isEnabled)
```
    Enables or disables a thematic configured in the current layer.
    
    Parameters:
    
    thematic - the thematic to enable.
    
    isEnabled - whether or not to enable it.
  - enableThematics
```
public void enableThematics(boolean isEnabled)
```
    Enables or disables all thematics configured in the current layer.
    
    Parameters:
    
    isEnabled - whether or not to enable them.
  - swapThematic
```
public void swapThematic(Thematic thematic,
                         int index)
```
    Moves a thematic to a specific position in the layer's thematics.
    
    Parameters:
    
    thematic - the thematic to move.
    
    index - the new index where the thematic has to move.
  - addThematic
```
public void addThematic(Thematic thematic)
```
    Adds a thematic to this layer.
    
    Parameters:
    
    thematic - the thematic to add.
  - removeThematic
```
public void removeThematic(Thematic thematic)
```
    Removes a thematic from this layer.
    
    Parameters:
    
    thematic - the thematic to remove.
  - draw
```
public void draw(GraphicsRef gr,
                 ViewState viewState,
                 OrientedRectangle region,
                 double scale,
                 DrawParameters drawParameters)
```
    Draws all elements contained in the specified region to the specified graphics object and applying the specified transformation.
    
    Specified by:
    
    draw in class Layer
    
    Parameters:
    
    gr - the graphics wrapper object to use.
    
    viewState - the view state.
    
    region - the world coordinate region to redraw.
    
    scale - the scale of the current View.
    
    drawParameters - drawParameters to use.
    
    See Also:
    
    LayerManager
  - draw
```
protected void draw(GraphicsRef gr,
                    ViewState viewState,
                    java.util.Vector<Tile> tileVec,
                    OrientedRectangle region,
                    double scale,
                    DrawParameters drawParameters)
```
    Draws all elements contained in the specified tiles and intersecting with the specified region to the specified graphics object and applying the specified transformation.
    
    Parameters:
    
    gr - the graphic reference to draw the elements.
    
    viewState - the view state that provides context information to draw the layer.
    
    tileVec - the vector containing the tiles to be drawn.
    
    region - the world coordinate region to redraw.
    
    scale - the scale of the current View.
    
    drawParameters - draw parameters to use.
    
    See Also:
    
    LayerManager
  - draw
```
@Deprecated
protected void draw(GraphicsRef gr,
                                ViewState viewState,
                                java.util.Vector<Tile> tileVec,
                                OrientedRectangle region,
                                double scale,
                                int drawOptions)
```
    Deprecated. use draw(GraphicsRef, ViewState, Vector, OrientedRectangle, double, DrawParameters) instead.
    
    Draws all elements contained in the specified tiles and intersecting with the specified region to the specified graphics object and applying the specified transformation.
    
    Parameters:
    
    gr - the graphic reference to draw the elements.
    
    viewState - the view state that provides context information to draw the layer.
    
    tileVec - the vector containing the tiles to be drawn.
    
    region - the world coordinate region to redraw.
    
    scale - the scale of the current View.
    
    drawOptions - draw options to use. Options can be retrieved with bitwise operations using LayerManager.DRAW_* constants.
    
    See Also:
    
    LayerManager
  - requestUnsyncData
```
public void requestUnsyncData(GraphicsRef gr,
                              ViewState viewState,
                              java.util.Vector<Tile> reqTiles,
                              OrientedRectangle region)
```
  - prepareSyncData
```
public void prepareSyncData(GraphicsRef gr,
                            ViewState viewState,
                            java.util.Vector<Tile> tileVec,
                            OrientedRectangle region)
```
  - drawImpl
```
@Deprecated
protected void drawImpl(GraphicsRef gr,
                                    ViewState viewState,
                                    java.util.Vector<Tile> tileVec,
                                    OrientedRectangle region,
                                    double scale,
                                    int drawOptions)
```
    Deprecated. use drawImpl(GraphicsRef, ViewState, Vector, OrientedRectangle, double, DrawParameters) instead.
  - drawImpl
```
protected void drawImpl(GraphicsRef gr,
                        ViewState viewState,
                        java.util.Vector<Tile> tileVec,
                        OrientedRectangle region,
                        double scale,
                        DrawParameters drawParameters)
```
  - drawGrid
```
public void drawGrid(GraphicsRef gr,
                     K2DTransform t)
```
    Draws a grid representing the tiles configuration of the layer.
    
    Specified by:
    
    drawGrid in class Layer
    
    Parameters:
    
    gr - the graphics wrapper to use.
    
    t - the transformation matrix of the view.
  - clone
```
public java.lang.Object clone()
```
    Returns a deep clone of the current LayerInfo instance.
    
    Specified by:
    
    clone in interface ILayer
    
    Specified by:
    
    clone in interface IVectorLayer
    
    Specified by:
    
    clone in interface LayerNode
    
    Specified by:
    
    clone in class Layer
    
    Returns:
    
    a clone of the current instance.
  - update
```
public void update(ILayer layer)
```
    Overrides:
    
    update in class Layer
  - toLayerInfo
```
public VectorLayerInfo toLayerInfo()
```
    Specified by:
    
    toLayerInfo in class Layer
  - share
```
public Shareable share()
```
    Creates a deep copy of the current layer, excluding geometries in elements of the layer which remain the same instances in all shared layers.
    
    Specified by:
    
    share in interface Shareable
    
    Returns:
    
    the new instance of the shared layer.
  - cloneImpl
```
protected void cloneImpl(IVectorLayer newLayer,
                         boolean sharedGeometry)
```
    Share method implementation.
    
    Parameters:
    
    newLayer - the new shared layer.
  - getElementsInSurface
```
@Deprecated
public java.util.Enumeration<K2DElement> getElementsInSurface(Surface wcSurface,
                                                                          View view,
                                                                          boolean onlyIfVisible)
```
    Deprecated. use getElementsInSurface(Surface, ViewState, boolean)
    
    Returns the enumeration of elements that are contained completely or partially in the specified world coordinate surface.
    
    Parameters:
    
    wcSurface - the world coordinate region to look into
    
    view - the view in which the test is done
    
    onlyIfVisible - specifies whether only visible elements should be returned.
    
    Returns:
    
    the enumeration of contained elements
  - getElementsInSurface
```
public java.util.Enumeration<K2DElement> getElementsInSurface(Surface wcSurface,
                                                              ViewState viewState,
                                                              boolean onlyIfVisible)
```
    Returns the enumeration of elements that are contained copmpletely or partially in the specified world coordinate surface.
    
    Parameters:
    
    wcSurface - the world coordinate region to look into
    
    viewState - the current view state.
    
    onlyIfVisible - specifies whether only visible elements should be returned.
    
    Returns:
    
    the enumeration of contained elements
    
    Since:
    
    JMap 4.0
  - getElementsOnLine
```
@Deprecated
public java.util.Enumeration<K2DElement> getElementsOnLine(LineString wcLine,
                                                                       View view,
                                                                       boolean onlyIfVisible)
```
    Deprecated. use getElementsOnLine(LineString, ViewState, boolean)
    
    Returns the enumeration of elements that are contained completely or partially on the specified world coordinate line.
    
    Parameters:
    
    wcLine - the world coordinate line to look onto
    
    view - the view in which the test is done
    
    onlyIfVisible - specifies whether only visible elements should be returned.
    
    Returns:
    
    the enumeration of contained elements
  - getElementsOnLine
```
public java.util.Enumeration<K2DElement> getElementsOnLine(LineString wcLine,
                                                           ViewState viewState,
                                                           boolean onlyIfVisible)
```
    Returns the enumeration of elements that are contained completely or partially on the specified world coordinate line.
    
    Parameters:
    
    wcLine - the world coordinate line to look onto
    
    viewState - the current view state.
    
    onlyIfVisible - specifies whether only visible elements should be returned.
    
    Returns:
    
    the enumeration of contained elements
    
    Since:
    
    JMap 4.0
  - getElementsInCircle
```
@Deprecated
public java.util.Enumeration<K2DElement> getElementsInCircle(Point WCCoord,
                                                                         View view,
                                                                         double radius,
                                                                         boolean onlyIfVisible)
```
    Deprecated. use getElementsInCircle(Point, ViewState, double, boolean)
    
    Returns the enumeration of elements that are contained completely or partially in the specified world coordinate circle.
    
    Parameters:
    
    WCCoord - the center of the circle in world coordinate
    
    view - the view in which the test is done
    
    radius - the radius of the circle
    
    onlyIfVisible - specifies whether only visible elements should be returned.
    
    Returns:
    
    the enumeration of contained elements
  - getElementsInCircle
```
public java.util.Enumeration<K2DElement> getElementsInCircle(Point WCCoord,
                                                             ViewState viewState,
                                                             double radius,
                                                             boolean onlyIfVisible)
```
    Returns the enumeration of elements that are contained completely or partially in the specified world coordinate circle.
    
    Parameters:
    
    WCCoord - the center of the circle in world coordinate
    
    viewState - the current view state.
    
    radius - the radius of the circle
    
    onlyIfVisible - specifies whether only visible elements should be returned.
    
    Returns:
    
    the enumeration of contained elements
    
    Since:
    
    JMap 4.0
  - getElementsAtPoint
```
@Deprecated
public java.util.Enumeration<K2DElement> getElementsAtPoint(Point WCCoord,
                                                                        View view,
                                                                        boolean onlyIfVisible)
```
    Deprecated. use getElementsAtPoint(Point, ViewState, boolean)
    
    Returns all the elements found at the specified point in world coordinate system or null if none is found.
    
    Parameters:
    
    WCCoord - the coordinate where to look for elements
    
    view - the view in which the test is done
    
    onlyIfVisible - specifies whether only visible elements should be returned.
    
    Returns:
    
    all the elements found at the specified point.
  - getElementsAtPoint
```
public java.util.Enumeration<K2DElement> getElementsAtPoint(Point WCCoord,
                                                            ViewState viewState,
                                                            boolean onlyIfVisible)
```
    Returns all the elements found at the specified point in world coordinate system or null if none is found.
    
    Parameters:
    
    WCCoord - the coordinate where to look for elements
    
    viewState - the current view state.
    
    onlyIfVisible - specifies whether only visible elements should be returned.
    
    Returns:
    
    an enumeration of all the elements found at the specified point
    
    Since:
    
    JMap 4.0
  - getElementAtPoint
```
@Deprecated
public K2DElement getElementAtPoint(Point WCCoord,
                                                View view,
                                                boolean onlyIfVisible)
```
    Deprecated. use getElementAtPoint(Point, ViewState, boolean)
    
    Returns the first element found at the specified point in world coordinate system or null if none is found.
    
    Parameters:
    
    WCCoord - the coordinate where to look for elements
    
    view - the view in which the test is done
    
    onlyIfVisible - specifies whether only a visible element should be returned.
    
    Returns:
    
    the first visible element found at the specified point.
  - getElementAtPoint
```
public K2DElement getElementAtPoint(Point WCCoord,
                                    ViewState viewState,
                                    boolean onlyIfVisible)
```
    Returns the first element found at the specified point in world coordinate system or null if none is found.
    
    Parameters:
    
    WCCoord - the coordinate where to look for elements
    
    viewState - the current view state.
    
    onlyIfVisible - specifies whether only a visible element should be returned.
    
    Returns:
    
    the first visible element found at the specified point.
    
    Since:
    
    JMap 4.0
  - addElement
```
public void addElement(K2DElement elem)
```
    Adds the specified element to the layer and then fires a LayerElementsAddedEvent.
    
    Parameters:
    
    elem - the element to add
    
    See Also:
    
    K2DElement
  - addElement
```
public void addElement(K2DElement element,
                       boolean fireEvent)
```
    Adds the specified element (K2DElement) to the layer.
    
    Parameters:
    
    element - the element to add
    
    fireEvent - indicates whether a LayerElementsAddedEvent is fired
    
    See Also:
    
    K2DElement
  - addElements
```
public void addElements(K2DElement[] elements)
```
    Adds the specified elements to the layer and then fires a LayerElementsAddedEvent.
    
    Parameters:
    
    elements - the elements to add
    
    See Also:
    
    K2DElement
  - addElements
```
public void addElements(K2DElement[] elements,
                        boolean fireEvent)
```
    Adds the specified elements (K2DElement) to the layer.
    
    Parameters:
    
    elements - the elements to add
    
    fireEvent - indicates whether a LayerElementsAddedEvent is fired
    
    See Also:
    
    K2DElement
  - fireElementsAddedEvent
```
protected void fireElementsAddedEvent(K2DElement[] elements)
```
  - fireElementsChangedEvent
```
public void fireElementsChangedEvent(K2DElement[] elements)
```
  - validateTiling
```
public void validateTiling(K2DElement[] elements)
```
  - removeElement
```
public boolean removeElement(K2DElement elem)
```
    Removes the specified element (K2DElement) from the layer.
    
    Parameters:
    
    elem - the element to remove
    
    Returns:
    
    true if the element was properly removed, false otherwise.
    
    See Also:
    
    K2DElement
  - removeElement
```
public boolean removeElement(K2DElement elem,
                             boolean fireEvent)
```
    Removes the specified element (K2DElement) from the layer.
    
    Parameters:
    
    elem - the element to remove
    
    fireEvent - indicates whether an event should be fired after removing the element
    
    Returns:
    
    true if the element was properly removed, false otherwise.
    
    See Also:
    
    K2DElement
  - removeElements
```
public boolean removeElements(K2DElement[] aElements)
```
    Removes the specified elements from the layer.
    
    Parameters:
    
    aElements - the element to remove
    
    Returns:
    
    true if one of the elements was properly removed, false otherwise.
    
    See Also:
    
    K2DElement
  - removeElements
```
public boolean removeElements(K2DElement[] aElements,
                              boolean fireEvent)
```
    Removes the specified elements from the layer.
    
    Parameters:
    
    aElements - the elements to remove
    
    fireEvent - indicates whether an event should be fired after removing the elements
    
    Returns:
    
    true if one of the elements was properly removed, false otherwise.
    
    See Also:
    
    K2DElement
  - removeElement
```
public boolean removeElement(long elemId)
```
    Removes the element that has the specified id from the layer.
    
    Parameters:
    
    elemId - the id of the element to be removed.
    
    Returns:
    
    true if the element was properly removed false otherwise.
  - removeElement
```
public boolean removeElement(long elemId,
                             boolean fireEvent)
```
    Removes the element that has the specified id from the layer.
    
    Parameters:
    
    elemId - the id of the element to be removed.
    
    fireEvent - indicates whether an event should be fired after removing the element
    
    Returns:
    
    true if the element was properly removed false otherwise.
  - fireElementRemovedEvent
```
protected void fireElementRemovedEvent(K2DElement[] elements)
```
  - getElementCount
```
public int getElementCount()
```
    Returns the number of elements contained by the layer. The element filters don't influence the result.
    
    Returns:
    
    the number of elements contained by the layer
  - removeAllElements
```
public void removeAllElements()
```
    Removes all the elements from this layer and fires an fireElementRemovedEvent event.
  - removeAllElements
```
public void removeAllElements(boolean fireEvent)
```
    Removes all the elements from this layer.
    
    Parameters:
    
    fireEvent - if a fireElementRemovedEvent has to be fired
  - getElementLabel
```
public java.lang.String getElementLabel(K2DElement elem)
```
    Returns the label string from the layer label column for the specified element.
    
    Parameters:
    
    elem - the element for which the label string must be returned
    
    Returns:
    
    the label string for the specified element
  - getElementLabel
```
public java.lang.String getElementLabel(K2DElement elem,
                                        Project project)
```
    Returns the label string from the layer label column for the specified element.
    
    Parameters:
    
    elem - the element for which the label string must be returned
    
    project - the project related to the specified element
    
    Returns:
    
    the label string for the specified element
  - getAllElements
```
@Deprecated
public K2DElement[] getAllElements()
```
    Deprecated. use getElements() instead
    
    Returns:
    
    An array containing all elements present on the layer and that pass the display filters of the layer..
  - getElements
```
public java.util.Collection<K2DElement> getElements()
```
    Returns:
    
    A collection containing all the elements present on the layer and that pass the display filters of the layer.
  - getElement
```
public K2DElement getElement(long id)
```
    Returns the element having the specified id or null if it does not exist. This method is slower than getElement(int tileIx, int elemIx) because it has to scan the elements.
    
    Parameters:
    
    id - the id of the element to retrieve.
    
    Returns:
    
    the element having the specified id, null if none was found.
  - getElement
```
public K2DElement getElement(int tileIx,
                             int elemIx)
```
    Returns the element contained in the specified tile at the specified position. The filters re applied.
    
    Parameters:
    
    tileIx - specifies the tile that is supposed to contain the requested element
    
    elemIx - specifies the element position in the tile
    
    Returns:
    
    the requested element or null if it is not found
  - addToSelection
```
public void addToSelection(K2DElement elem)
```
    Adds the specified element to the selection of the layer. Fires a LayerSelChangedEvent.
    
    Parameters:
    
    elem - the element to add to the selection.
    
    See Also:
    
    LayerSelChangedEvent
  - addToSelection
```
public void addToSelection(K2DElement elem,
                           boolean fireEvent)
```
    Adds the specified element to the selection of the layer. Fires a LayerSelChangedEvent.
    
    Parameters:
    
    elem - the element to add to the selection.
    
    fireEvent - whether or not to fire the selection event.
    
    See Also:
    
    LayerSelChangedEvent
  - addToSelection
```
public void addToSelection(java.util.Collection<K2DElement> elems)
```
    Adds the specified elements to the selection of the layer. Fires a LayerSelChangedEvent.
    
    Parameters:
    
    elems - the elements to add to the selection.
    
    See Also:
    
    LayerSelChangedEvent
  - addToSelection
```
public void addToSelection(java.util.Collection<K2DElement> elems,
                           boolean fireEvent)
```
    Adds the specified elements to the selection of the layer. Fires a LayerSelChangedEvent.
    
    Parameters:
    
    elems - the elements to add to the selection.
    
    fireEvent - whether or not to fire the selection event.
    
    See Also:
    
    LayerSelChangedEvent
  - getSelection
```
public java.util.Collection<K2DElement> getSelection()
```
    Gets the selected elements
    
    Returns:
    
    an Enumeration of the selected elements of the layer.
  - getSelectedElements
```
public K2DElement[] getSelectedElements()
```
    Gets the selected elements
    
    Returns:
    
    an Array of the selected elements of the layer.
  - getSelectionSize
```
public int getSelectionSize()
```
    Gets the selection count
    
    Returns:
    
    the number of selected elements of the layer.
  - getDefaultSelectionStyle
```
public Style getDefaultSelectionStyle()
```
    Gets the default selection style
    
    Returns:
    
    the style of selected elements of the layer.
  - getDisplaySelectedBounds
```
@Deprecated
public Rectangle getDisplaySelectedBounds(View view)
```
    Deprecated. use getDisplaySelectedBounds(ViewState)
    
    Returns the DC bounding box of the current selection of the layer.
    
    Parameters:
    
    view - the view to use when calculating the bounding box.
    
    Returns:
    
    the bounding box of the selection or null if no elements are selected
  - getDisplaySelectedBounds
```
public Rectangle getDisplaySelectedBounds(ViewState viewState)
```
    Returns the DC bounding box of the current selection of the layer.
    
    Parameters:
    
    viewState - the current view state.
    
    Returns:
    
    the bounding box of the selection or null if no elements are selected
    
    Since:
    
    JMap 4.0
  - getDisplaySelectedBounds
```
public Rectangle getDisplaySelectedBounds(ViewState viewState,
                                          boolean zoomed)
```
    Returns the DC bounding box of the current selection of the layer.
    
    Parameters:
    
    viewState - the current view state.
    
    zoomed - defines if display selected bounds should be computed with the transformation matrix scaled at the geometry extent (zoomed) or at the current scale (not zoomed).
    
    Returns:
    
    the bounding box of the selection or null if no elements are selected
    
    Since:
    
    JMap 4.0.2
  - drawSelection
```
public void drawSelection(GraphicsRef gr,
                          ViewState viewState,
                          double scale)
```
    Draws the selected elements of the layer.
    
    Parameters:
    
    gr - the Graphics wrapper object used to draw the selected elements
    
    viewState - the view state
    
    scale - the scale of the current View.
  - clearSelection
```
public void clearSelection()
```
    Empties the selection of the layer. Fires a LayerSelChangedEvent.
    
    See Also:
    
    LayerSelChangedEvent
  - invertSelection
```
public void invertSelection()
```
    Inverts the selection on this layer. All selected elements get unselected while all unselected elements become selected. Fires selection events.
  - selectAll
```
public void selectAll()
```
  - unselectElement
```
@Deprecated
public void unselectElement(K2DElement elem)
```
    Deprecated. Use removeFromSelection(K2DElement) instead.
    
    Removes the specified element from the selection of the layer. Fires a LayerSelChangedEvent.
    
    Parameters:
    
    elem - the element to remove from the selection
    
    See Also:
    
    LayerSelChangedEvent
  - removeFromSelection
```
public void removeFromSelection(K2DElement elem)
```
    Removes the specified element from the selection of the layer. Fires a LayerSelChangedEvent.
    
    Parameters:
    
    elem - the element to remove from the selection
    
    See Also:
    
    LayerSelChangedEvent
  - unselectElement
```
@Deprecated
public void unselectElement(K2DElement elem,
                                        boolean fireEvent)
```
    Deprecated. Use removeFromSelection(K2DElement, boolean) instead.
    
    Removes the specified element from the selection of the layer. Fires a LayerSelChangedEvent if the specified boolean parameter is true..
    
    Parameters:
    
    elem - the element to remove from the selection
    
    fireEvent - whether or not to fire a layer selection event.
    
    See Also:
    
    LayerSelChangedEvent
  - removeFromSelection
```
public void removeFromSelection(K2DElement elem,
                                boolean fireEvent)
```
    Removes the specified element from the selection of the layer. Fires a LayerSelChangedEvent if the specified boolean parameter is true.
    
    Parameters:
    
    elem - the element to remove from the selection
    
    fireEvent - whether or not to fire a layer selection event.
    
    See Also:
    
    LayerSelChangedEvent
  - removeFromSelection
```
public void removeFromSelection(java.util.Vector<K2DElement> elements,
                                boolean fireEvent)
```
    Removes the specified elements from the selection of the layer. Fires a LayerSelChangedEvent if the specified boolean parameter is true.
    
    Parameters:
    
    elements - the elements to remove from the selection
    
    fireEvent - whether or not to fire a layer selection event.
    
    See Also:
    
    LayerSelChangedEvent
  - removeFromSelection
```
public void removeFromSelection(java.util.Vector<K2DElement> elements)
```
    Removes the specified elements from the selection of the layer. Fires a LayerSelChangedEvent.
    
    Parameters:
    
    elements - the elements to remove from the selection
    
    See Also:
    
    LayerSelChangedEvent
  - fireDataRequestedEvent
```
protected void fireDataRequestedEvent(OrientedRectangle region,
                                      boolean sync)
```
  - fireDataRequestedEvent
```
protected void fireDataRequestedEvent(java.util.Vector<Tile> reqTiles,
                                      boolean sync)
```
  - fireSelChangedEvent
```
protected void fireSelChangedEvent(java.util.Vector<K2DElement> elems,
                                   int operType)
```
  - fireSelChangedEvent
```
protected void fireSelChangedEvent(K2DElement elem,
                                   int operType)
```
  - fireDisplayFilterChangedEvent
```
protected void fireDisplayFilterChangedEvent(LayerDisplayFilterChangedEvent event)
```
  - fireAttributeMetadataChangedEvent
```
protected void fireAttributeMetadataChangedEvent(LayerAttributeMetadataChangedEvent event)
```
  - fireQueryfilterChangedEvent
```
protected void fireQueryfilterChangedEvent(LayerQueryFilterChangedEvent event)
```
  - addQueryFilter
```
public void addQueryFilter(QueryFilter filter)
```
    Adds a new query filter to the list of filters for the layer.
    
    Parameters:
    
    filter - the filter to add
  - removeQueryFilter
```
public void removeQueryFilter(QueryFilter filter)
```
    Removes the specified query filter from the list of filters for the layer.
    
    Parameters:
    
    filter - the filter to remove
  - getQueryFilters
```
public QueryFilter[] getQueryFilters()
```
    Returns:
    
    an array containing the current query filters for the layer
  - removeAllQueryFilters
```
public void removeAllQueryFilters()
```
    Remove all query filters from the layer
  - addDisplayFilter
```
public void addDisplayFilter(DisplayFilter filter)
```
    Adds a new filter to the list of display filters for the layer. Filters are applied in the order they are added.
    
    Parameters:
    
    filter - the filter to add
  - removeDisplayFilter
```
public void removeDisplayFilter(DisplayFilter filter)
```
    Removes the specified filter from the list of display filters for the layer.
    
    Parameters:
    
    filter - the filter to remove
  - getDisplayFilters
```
public DisplayFilter[] getDisplayFilters()
```
    Returns:
    
    an array containing the current display filters for the layer
  - removeAllDisplayFilters
```
public void removeAllDisplayFilters()
```
    Remove all display filters from the layer
  - applyFilters
```
public boolean applyFilters(K2DElement elem)
```
    Returns whether or not the specified element was accepted by the current display filters configured in the layer.
    
    Parameters:
    
    elem - the element to test.
    
    Returns:
    
    whether or not the element should be displayed.
  - alwayDrawSelection
```
public boolean alwayDrawSelection()
```
    Returns whether or not the layer selection will always be drawn.
    If enabled, the selection will be drawn at any scale, even if the layer is not visible.
    
    Returns:
    
    a boolean that specifies if the layer selection will always be drawn
  - setAlwayDrawSelection
```
public void setAlwayDrawSelection(boolean isTrue)
```
    Enables layer selection to always be drawn.
    If enabled, the selection will be drawn at any scale, even if the layer is not visible.
    
    Parameters:
    
    isTrue - a boolean value
  - getExtent
```
public Rectangle getExtent()
```
    Returns a clone of the layer extent.
    
    Specified by:
    
    getExtent in interface ILayer
    
    Specified by:
    
    getExtent in class Layer
    
    Returns:
    
    the layer extent.
  - getSelectedExtent
```
public Rectangle getSelectedExtent()
```
    Returns the extent created from selected element geometries in the current layer.
    
    Returns:
    
    the bounding box of the selected element geometries in the layer.
  - computeExtent
```
public Rectangle computeExtent(java.util.Collection<K2DElement> elements)
```
  - computeDisplayBounds
```
public Rectangle computeDisplayBounds(ViewState viewState,
                                      java.util.Collection<K2DElement> elements,
                                      boolean onlyIfVisible)
```
  - computeZoomedDisplayBounds
```
public Rectangle computeZoomedDisplayBounds(ViewState viewState,
                                            java.util.Collection<K2DElement> elements,
                                            boolean onlyIfVisible)
```
  - setOffset
```
public void setOffset(Point offset)
```
    Sets the Offset
    
    Specified by:
    
    setOffset in interface IVectorLayer
    
    Parameters:
    
    offset - the corresponding offset
  - getOffset
```
public Point getOffset()
```
    Gets the offset
    
    Specified by:
    
    getOffset in interface IVectorLayer
    
    Returns:
    
    the offset of the layer
  - getUseClientCache
```
public boolean getUseClientCache()
```
    Gets the useClientCache boolean flag
    
    Specified by:
    
    getUseClientCache in interface IVectorLayer
    
    Returns:
    
    true if the use of cache on the client is enabled, false otherwise
  - setUseClientCache
```
public void setUseClientCache(boolean flag)
```
    Sets useClientCache boolean flag
    
    Specified by:
    
    setUseClientCache in interface IVectorLayer
    
    Parameters:
    
    flag - the boolean value to be set.
  - getOffsetTransform
```
public K2DTransform getOffsetTransform(K2DTransform t)
```
    Gets the offset transformation matrix
    
    Parameters:
    
    t - the transformation that is applied
    
    Returns:
    
    the new transformation matrix that also translates the elements by the offset
    
    See Also:
    
    K2DTransform
  - close
```
public void close()
```
    Clears all elements in the layer and removes all configured listeners.
    
    Specified by:
    
    close in class Layer
  - setEditing
```
public void setEditing(boolean flag)
```
  - isEditing
```
public boolean isEditing()
```
  - setEditable
```
public void setEditable(boolean editable)
```
    Adds or removes edition permissions on the layer: Permission.ADD_LAYER_ELEMENT, Permission.EDIT_LAYER_ELEMENT, Permission.DELETE_LAYER_ELEMENT and Permission.EDIT_LAYER_ATTRIBUTE_VALUES.
    
    Parameters:
    
    editable - whether or not this layer is editable.
  - isEditable
```
public boolean isEditable()
```
    Returns whether or not this layer is editable.
    
    Specified by:
    
    isEditable in interface IVectorLayer
    
    Returns:
    
    the boolean value whether or not this layer is editable.
  - sendToBack
```
public void sendToBack(K2DElement[] elements)
```
    Moves the specified elements to the lowest z order position. Only allowed on layers with the universe tile as the only tile.
    
    Parameters:
    
    elements - the elements to send to back
  - bringToFront
```
public void bringToFront(K2DElement[] elements)
```
    Moves the specified elements to the highest z order position. Only allowed on layers with the universe tile as the only tile.
    
    Parameters:
    
    elements - the elements to bring to front
  - bringForward
```
public void bringForward(K2DElement[] elements)
```
    Moves the specified elements one z order position up. Only allowed on layers with the universe tile as the only tile.
    
    Parameters:
    
    elements - the elements to bring forward
  - sendBackward
```
public void sendBackward(K2DElement[] elements)
```
    Moves the specified elements one z order position down. Only allowed on layers with the universe tile as the only tile.
    
    Parameters:
    
    elements - the elements to send backward
  - getStyle
```
public Style getStyle(K2DElement elem,
                      double scale)
```
    Returns the current style for the specified element. The current style is based on the element selection state, enabled thematics in the layer and the specified scale.
    If the specified element has no style for any enabled thematics in the layer, null is returned.
    
    Parameters:
    
    elem - the element.
    
    scale - the current scale of the view.
    
    Returns:
    
    the current element style. If the element should not be drawn, null is returned.
  - getSelectionStyle
```
public Style getSelectionStyle(K2DElement elem,
                               double scale)
```
    Returns the current selection style for the specified element. The selection style is based on enabled thematics in the layer and the specified scale.
    If the specified element has no style for any enabled thematics in the layer, null is returned.
    
    Parameters:
    
    elem - the element.
    
    scale - the current scale.
    
    Returns:
    
    the current selection element style. If the element should not be drawn, null is returned.
  - getSelectionStyle
```
public Style getSelectionStyle()
```
    Returns the default selection style object associated with the layer.
    Note: If this layer has more than one style (depending on the view scale), the lowest scale selection style is returned.
    If the layer is editable, the default edition style of the layer will be returned.
    
    Overrides:
    
    getSelectionStyle in class Layer
    
    Returns:
    
    the default selection style of the layer
    
    See Also:
    
    Style, StyleManager.getSelectionStyle(double scale)
  - getSelectionStyle
```
public Style getSelectionStyle(double scale)
```
    Returns the selection style object associated with the layer for the specified scale.
    If the layer is editable, the edition style of the layer corresponding to the specified scale will be returned.
    
    Overrides:
    
    getSelectionStyle in class Layer
    
    Parameters:
    
    scale - the scale of the current View.
    
    Returns:
    
    the selection style of the layer for the specified scale.
    
    See Also:
    
    Style, StyleManager.getSelectionStyle(double scale)
  - getRequestMode
```
public int getRequestMode()
```
    Description copied from class: Layer
    
    Returns the request mode for this layer. The request mode can be either by tile (REQUEST_MODE_TILE) or by random region (REQUEST_MODE_REGION). When using requests by tile, predimensionned tiles are exchanged between JMapServer and the client application. When using requests by region, random regions of data are exchanged depending on the region the user is viewing. Requests by tiles are generally more performant because they allow caching on the server and client sides. Requests by region are useful when data must always be up-to-date, as it will be requested each time from the spatial data source.
    
    Specified by:
    
    getRequestMode in interface IVectorLayer
    
    Specified by:
    
    getRequestMode in class Layer
    
    Returns:
    
    the current request mode in use by this layer.
  - setRequestMode
```
public void setRequestMode(int requestMode)
```
    Sets the request mode for this layer.
    
    Specified by:
    
    setRequestMode in interface IVectorLayer
    
    Parameters:
    
    requestMode - the request mode to use ( LayerInfo.REQUEST_MODE_BY_TILE or LayerInfo.REQUEST_MODE_BY_REGION).
  - getLabelsConfig
```
public LabelsConfiguration getLabelsConfig()
```
    Returns the labels configuration for this layer.
    
    Specified by:
    
    getLabelsConfig in interface IVectorLayer
    
    Returns:
    
    the labels configuration.
  - setLabelsConfig
```
public void setLabelsConfig(LabelsConfiguration labelsConfig)
```
    Sets the labels configuration for this layer.
    
    Specified by:
    
    setLabelsConfig in interface IVectorLayer
    
    Parameters:
    
    labelsConfig - the label configuration.
  - getHyperlinks
```
public Hyperlink[] getHyperlinks()
```
    Specified by:
    
    getHyperlinks in interface IVectorLayer
  - setHyperlinks
```
public void setHyperlinks(Hyperlink[] hyperlinks)
```
    Specified by:
    
    setHyperlinks in interface IVectorLayer
  - setLastTransform
```
@Deprecated
public void setLastTransform(K2DTransform t,
                                         GraphicsRef gr)
```
    Deprecated. use Layer.revalidate(K2DTransform) instead
    
    Sets the last view transformation matrix that was used to draw the layer.
    
    Parameters:
    
    t - the view transformation matrix.
    
    gr - the view graphics reference instance.
    
    See Also:
    
    invalidate()
  - loadData
```
public void loadData(Geometry bounds,
                     boolean sync)
```
    This method automatically loads the data tiles intersecting with the specified geometry.
    
    Specified by:
    
    loadData in class Layer
    
    Parameters:
    
    bounds - the geometry used to delimit the bounds of the data to load
    
    sync - whether his method is blocking (true) or non blocking (false)
  - getMouseOverConfiguration
```
public MouseOverConfiguration getMouseOverConfiguration()
```
    Specified by:
    
    getMouseOverConfiguration in interface IVectorLayer
    
    Returns:
    
    the mouse over configuration
  - setMouseOverConfiguration
```
public void setMouseOverConfiguration(MouseOverConfiguration mouseOverConfiguration)
```
    Specified by:
    
    setMouseOverConfiguration in interface IVectorLayer
  - getForms
```
public java.util.List<FormInfo> getForms()
```
    Specified by:
    
    getForms in interface IVectorLayer
  - setForms
```
public void setForms(java.util.List<FormInfo> forms)
```
    Specified by:
    
    setForms in interface IVectorLayer
  - getSubForms
```
public java.util.List<SubFormInfo> getSubForms()
```
    Specified by:
    
    getSubForms in interface IVectorLayer
  - setSubForms
```
public void setSubForms(java.util.List<SubFormInfo> subForms)
```
    Specified by:
    
    setSubForms in interface IVectorLayer
  - getForm
```
public AbstractFormInfo getForm(int id)
```
    Returns the form or subfom with the specified id.
    
    Parameters:
    
    id -
    
    Returns:
  - hasElementsInSurface
```
public boolean hasElementsInSurface(Surface wcSurface,
                                    ViewState viewState,
                                    boolean onlyIfVisible)
```
    Returns whether at least one element is contained completely or partially in the specified world coordinate surface.
    
    Parameters:
    
    wcSurface - the world coordinate region to look into
    
    viewState - the current view state.
    
    onlyIfVisible - specifies whether only visible elements should be returned.
    
    Returns:
    
    true if the specified surface contains elements, false otherwise
    
    Since:
    
    JMap 4.0.2
  - getAcl
```
public final Acl getAcl()
```
    Specified by:
    
    getAcl in interface IVectorLayer
    
    Returns:
    
    acl for VectorLayers
  - setAcl
```
public final void setAcl(Acl acl)
```
    Specified by:
    
    setAcl in interface IVectorLayer
    
    Parameters:
    
    acl - for VectorLayers
  - invalidate
```
public void invalidate()
```
    Invalidates the current layer. NOTE: This does not invalidate the DiskCache. To invalidate the disk cache, call the invalidateLayer method of the LayerManager containing the layer
    
    Overrides:
    
    invalidate in class Layer
    
    Since:
    
    6.5
  - getDisplayStrategyManager
```
public VectorDisplayStrategyManager getDisplayStrategyManager()
```
  - getHeatMapDisplayStrategyInfo
```
public HeatMapDisplayStrategyInfo getHeatMapDisplayStrategyInfo()
```
    Specified by:
    
    getHeatMapDisplayStrategyInfo in interface IVectorLayer
  - setHeatMapDisplayStrategyInfo
```
public void setHeatMapDisplayStrategyInfo(HeatMapDisplayStrategyInfo heatMapDisplayStrategyInfo)
```
    Specified by:
    
    setHeatMapDisplayStrategyInfo in interface IVectorLayer
  - getClusterDisplayStrategyInfo
```
public ClusterDisplayStrategyInfo getClusterDisplayStrategyInfo()
```
    Specified by:
    
    getClusterDisplayStrategyInfo in interface IVectorLayer
  - setClusterDisplayStrategyInfo
```
public void setClusterDisplayStrategyInfo(ClusterDisplayStrategyInfo clusterDisplayStrategyInfo)
```
    Specified by:
    
    setClusterDisplayStrategyInfo in interface IVectorLayer

Class VectorLayer

Field Summary

Fields inherited from class com.kheops.jmap.client.layers.Layer

Fields inherited from interface com.kheops.jmap.client.layers.IVectorLayer

Fields inherited from interface com.kheops.jmap.client.layers.LayerConstants

Constructor Summary

Method Summary

Methods inherited from class com.kheops.jmap.client.layers.Layer

Methods inherited from class com.kheops.jmap.metadata.LocalizedObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.kheops.jmap.client.layers.IVectorLayer

Methods inherited from interface com.kheops.jmap.client.layers.ILayer

Field Detail

displayFilters

queryFilters

tileSet

offset

attribMetaData

mouseOverConfiguration

labelsConfig

hyperlinks

thematics

selection

requestMode

queryFiltersChanged

forms

subForms

idAttributeName

keyAttributeName

creationTimeColumnName

modificationTimeColumnName

authorColumnName

Constructor Detail

VectorLayer

VectorLayer

VectorLayer

VectorLayer

VectorLayer

Method Detail

getAttributeMetaData

getAttributeIndex

setAttributeMetaData

getTiles

getUpdateLock

setTiles

getThematics

getThematic

getEnabledThematics

setThematics

enableThematic

enableThematic

enableThematics

swapThematic

addThematic

removeThematic

draw

draw

draw

requestUnsyncData

prepareSyncData

drawImpl

drawImpl

drawGrid

clone

update

toLayerInfo

share

cloneImpl

getElementsInSurface

getElementsInSurface

getElementsOnLine

getElementsOnLine

getElementsInCircle

getElementsInCircle

getElementsAtPoint

getElementsAtPoint

getElementAtPoint

getElementAtPoint

addElement

addElement