ClientLayerInfo (Geomajas server: Main

java.lang.Object
- org.geomajas.configuration.client.ClientLayerInfo

All Implemented Interfaces:

Serializable, IsInfo

Direct Known Subclasses:

ClientRasterLayerInfo, ClientVectorLayerInfo
```
@Api(allMethods=true)
public abstract class ClientLayerInfo
extends Object
implements IsInfo
```
Abstract class that contains the metadata properties that are common to all client layers. The coupling with the server layer is established via the layerInfo field.

Since:

1.6.0

Author:

Jan De Moerloose, Oliver May

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

ClientLayerInfo()

Constructors
Constructor and Description
`ClientLayerInfo()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getCrs()` Get the crs of this layer (same as server layer).
`String`	`getId()` Get the unique id of this layer.
`String`	`getLabel()` Get the user label of this layer.
`LayerInfo`	`getLayerInfo()` Get the layer information of this layer (optional, auto-copied from Spring context).
`LayerType`	`getLayerType()` Get the type of this layer (same as server layer).
`org.geomajas.geometry.Bbox`	`getMaxExtent()` Get the maximum visible extent of this layer (in map space).
`ScaleInfo`	`getMaximumScale()` Get the maximum scale for which this layer should be visible (maximum zoom in).
`ScaleInfo`	`getMinimumScale()` Get the minimum scale for which this layer should be visible (maximum zoom out).
`String`	`getServerLayerId()` Get the layer id of the server layer.
`ClientUserDataInfo`	`getUserData()` Get the custom configuration data.
`double`	`getViewScaleMax()` Deprecated. use `getMaximumScale()`
`double`	`getViewScaleMin()` Deprecated. use `getMinimumScale()`
`Map<String,ClientWidgetInfo>`	`getWidgetInfo()` Get configuration for (custom) layer widgets.
`ClientWidgetInfo`	`getWidgetInfo(String widget)` Get configuration for a (custom) layer widgets.
`ScaleInfo`	`getZoomToPointScale()` Get the scale that should be used when zooming in on a point feature.
`boolean`	`isVisible()` Is this layer be visible at startup ?
`void`	`setId(String id)` Set the unique id of this layer (auto-copied from Spring context).
`void`	`setLabel(String label)` Set the user label of this layer.
`void`	`setLayerInfo(LayerInfo layerInfo)` Set the layer information of this layer (optional, auto-copied from Spring context).
`void`	`setMaxExtent(org.geomajas.geometry.Bbox maxExtent)` Set the maximum visible extent of this layer in map space (auto-set by Spring).
`void`	`setMaximumScale(ScaleInfo maximumScale)` Set the maximum scale for which this layer should be visible (maximum zoom in).
`void`	`setMinimumScale(ScaleInfo minimumScale)` Set the minimum scale for which this layer should be visible (maximum zoom out).
`void`	`setServerLayerId(String serverLayerId)` Set the server layer id.
`void`	`setUserData(ClientUserDataInfo userData)` Set the custom configuration data you wish to pass to the client.
`void`	`setViewScaleMax(double viewScaleMax)` Deprecated. use `setMaximumScale(ScaleInfo)`
`void`	`setViewScaleMin(double viewScaleMin)` Deprecated. use `setMinimumScale(ScaleInfo)`}
`void`	`setVisible(boolean visible)` Set this layer visible at startup.
`void`	`setWidgetInfo(Map<String,ClientWidgetInfo> widgetInfo)` Set configuration for (custom) layer widgets.
`void`	`setZoomToPointScale(ScaleInfo zoomToPointScale)` Set the scale that should be used when zooming in on a point feature.

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

- Constructor Detail
  - ClientLayerInfo
```
public ClientLayerInfo()
```
- Method Detail
  - getId
```
public String getId()
```
    Get the unique id of this layer.
    
    Returns:
    the unique id
  - setId
```
public void setId(String id)
```
    Set the unique id of this layer (auto-copied from Spring context).
    
    Parameters:
    id - id
  - getServerLayerId
```
public String getServerLayerId()
```
    Get the layer id of the server layer.
    
    Returns:
    layer id
  - setServerLayerId
```
public void setServerLayerId(String serverLayerId)
```
    Set the server layer id. This should be the name of an existing Layer bean.
    
    Parameters:
    serverLayerId - server layer id
  - getLabel
```
public String getLabel()
```
    Get the user label of this layer.
    
    Returns:
    layer id
  - setLabel
```
public void setLabel(String label)
```
    Set the user label of this layer.
    
    Parameters:
    label - label
  - isVisible
```
public boolean isVisible()
```
    Is this layer be visible at startup ?
    
    Returns:
    true if visible
  - setVisible
```
public void setVisible(boolean visible)
```
    Set this layer visible at startup.
    
    Parameters:
    visible - visible status
  - getViewScaleMin
```
@Deprecated
public double getViewScaleMin()
```
    Deprecated. use getMinimumScale()
    
    Get the minimum scale for which this layer should be visible (maximum zoom out).
    
    Returns:
    minimum scale (pix/map unit)
  - setViewScaleMin
```
@Deprecated
public void setViewScaleMin(double viewScaleMin)
```
    Deprecated. use setMinimumScale(ScaleInfo)}
    
    Set the minimum scale for which this layer should be visible (maximum zoom out).
    
    Parameters:
    viewScaleMin - scale (pix/map unit)
  - getViewScaleMax
```
@Deprecated
public double getViewScaleMax()
```
    Deprecated. use getMaximumScale()
    
    Get the maximum scale for which this layer should be visible (maximum zoom in).
    
    Returns:
    maximum scale (pix/map unit)
  - setViewScaleMax
```
@Deprecated
public void setViewScaleMax(double viewScaleMax)
```
    Deprecated. use setMaximumScale(ScaleInfo)
    
    Set the maximum scale for which this layer should be visible (maximum zoom in).
    
    Parameters:
    viewScaleMax - scale (pix/map unit)
  - getMinimumScale
```
public ScaleInfo getMinimumScale()
```
    Get the minimum scale for which this layer should be visible (maximum zoom out).
    
    Returns:
    the minimum scale (unit type is defined in )
    Since:
    
    1.7.0
  - setMinimumScale
```
public void setMinimumScale(ScaleInfo minimumScale)
```
    Set the minimum scale for which this layer should be visible (maximum zoom out).
    
    Parameters:
    minimumScale - the minimum scale
    Since:
    
    1.7.0
  - getMaximumScale
```
public ScaleInfo getMaximumScale()
```
    Get the maximum scale for which this layer should be visible (maximum zoom in).
    
    Returns:
    the maximum scale
    Since:
    
    1.7.0
  - setMaximumScale
```
public void setMaximumScale(ScaleInfo maximumScale)
```
    Set the maximum scale for which this layer should be visible (maximum zoom in).
    
    Parameters:
    maximumScale - the maximum scale
    Since:
    
    1.7.0
  - getZoomToPointScale
```
public ScaleInfo getZoomToPointScale()
```
    Get the scale that should be used when zooming in on a point feature. Defaults to the maximumScale of the layer.
    
    Returns:
    the scale
    Since:
    
    1.11.0
  - setZoomToPointScale
```
public void setZoomToPointScale(ScaleInfo zoomToPointScale)
```
    Set the scale that should be used when zooming in on a point feature. Defaults to the maximumScale of the layer.
    
    Parameters:
    zoomToPointScale - the scale
    Since:
    
    1.11.0
  - getMaxExtent
```
public org.geomajas.geometry.Bbox getMaxExtent()
```
    Get the maximum visible extent of this layer (in map space).
    
    Returns:
    maximum visible extent
  - setMaxExtent
```
public void setMaxExtent(org.geomajas.geometry.Bbox maxExtent)
```
    Set the maximum visible extent of this layer in map space (auto-set by Spring).
    
    Parameters:
    maxExtent - visible extent
  - getLayerInfo
```
public LayerInfo getLayerInfo()
```
    Get the layer information of this layer (optional, auto-copied from Spring context).
    
    Returns:
    layer information
  - setLayerInfo
```
public void setLayerInfo(LayerInfo layerInfo)
```
    Set the layer information of this layer (optional, auto-copied from Spring context).
    
    Parameters:
    layerInfo - information
  - getLayerType
```
public LayerType getLayerType()
```
    Get the type of this layer (same as server layer).
    
    Returns:
    layer type
  - getCrs
```
public String getCrs()
```
    Get the crs of this layer (same as server layer).
    
    Returns:
    crs
  - getWidgetInfo
```
@Api
public Map<String,ClientWidgetInfo> getWidgetInfo()
```
    Get configuration for (custom) layer widgets.
    
    Returns:
    map keyed on widget id containing widget configurations
    Since:
    
    1.8.0
  - getWidgetInfo
```
@Api
public ClientWidgetInfo getWidgetInfo(String widget)
```
    Get configuration for a (custom) layer widgets.
    
    Parameters:
    widget - widget key
    
    Returns:
    widget configuration
    Since:
    
    1.8.0
  - setWidgetInfo
```
public void setWidgetInfo(Map<String,ClientWidgetInfo> widgetInfo)
```
    Set configuration for (custom) layer widgets.
    
    Parameters:
    widgetInfo - map keyed on widget id containing widget configurations
    Since:
    
    1.8.0
  - getUserData
```
public ClientUserDataInfo getUserData()
```
    Get the custom configuration data.
    
    Returns:
    custom configuration data
  - setUserData
```
public void setUserData(ClientUserDataInfo userData)
```
    Set the custom configuration data you wish to pass to the client.
    
    Parameters:
    userData - Custom configuration data

Class ClientLayerInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClientLayerInfo

Method Detail

getId

setId

getServerLayerId

setServerLayerId

getLabel

setLabel

isVisible

setVisible

getViewScaleMin

setViewScaleMin

getViewScaleMax

setViewScaleMax

getMinimumScale

setMinimumScale

getMaximumScale

setMaximumScale

getZoomToPointScale

setZoomToPointScale

getMaxExtent

setMaxExtent

getLayerInfo

setLayerInfo

getLayerType

getCrs

getWidgetInfo

getWidgetInfo

setWidgetInfo

getUserData

setUserData