# Legato.Control.SelectionBoxValueProvider

A menu button which integrates the <OpenLayers.Control.Panel>. If triggered an vector will been painted by moving the mouse. If selection is done and the getValue callback function is implemented, you’ll reveive the currently painted bbox. On the oposite you have the possibility to initialize this control by implementing the setValue function.

#### Inherits from

- Legato.Control

#### See Also

- <OpenLayers.Control.Panel>

Summary

Legato.Control.SelectionBoxValueProvider | A menu button which integrates the <OpenLayers.Control.Panel>.
Properties |
type | {String} OpenLayers.Control.TYPE_TOOL
selectionLayer | {OpenLayers.Feature.Vector} The vector layer which will be created and managed by this control
styleMap | {<OpenLayers.StyleMap>}
Selection | {String} The default name of the selection box layer.
defaultOpacity | {Number} The default opacity value of the selectionbox layer.
Functions |
initialize | Basic ctor
destroy | <OpenLayer.Control>
draw | <OpenLayer.Control>
lc:SelectionBoxValueProvider | XML based config for a <Legato.Control.lc:SelectionBoxValueProvider>.
Properties |
QName | The qualified name for this control.
opacity |
layerName |
left | Defines the {DOMElement} id where the left <OpenLayers.Bounds> value should be written into.
right | Defines the {DOMElement} id where the right <OpenLayers.Bounds> value should be written into.
top | Defines the {DOMElement} id where the top <OpenLayers.Bounds> value should be written into.
bottom | Defines the {DOMElement} id where the bottom <OpenLayers.Bounds> value should be written into.

### Properties

### type

{String} OpenLayers.Control.TYPE_TOOL

### selectionLayer

{OpenLayers.Feature.Vector} The vector layer which will be created and managed by this control

#### See Also

<OpenLayers.Feature.Vector>

### styleMap

{<OpenLayers.StyleMap>}

### Selection

{String} The default name of the selection box layer. Will be used if not defined in ctor.

### defaultOpacity

{Number} The default opacity value of the selectionbox layer. Will be used if not defined in ctor.

### Functions

### initialize

> initialize : function( | options | )

Basic ctor

#### Parameters

options | {Object} A Hashmap containing option parameters for this control The following keys are supported

- target {object} an object which wants to observe,
- property{function|String} the propety or function which should be used for providing the observed value
- bBoxProperty {String} any Property name of an <OpenLayers.Bounds> instance

### destroy

> destroy : function()

#### See Also

<OpenLayer.Control>

### draw

> draw: function()

#### See Also

<OpenLayer.Control>

## lc:SelectionBoxValueProvider

XML based config for a <Legato.Control.lc:SelectionBoxValueProvider>.

#### See Also

- Legato.Control
- Legato.Beans.BeanFactory
- QName

#### A valid config example for a Legend would be

>     <lc:SelectionBoxValueProvider opacity="0.5" layerName="Foo" left="selectionLeft" right="selectionRight" top="selectionTop" bottom="selectionBottom"/>

Summary

Properties |
QName | The qualified name for this control.
opacity |
layerName |
left | Defines the {DOMElement} id where the left <OpenLayers.Bounds> value should be written into.
right | Defines the {DOMElement} id where the right <OpenLayers.Bounds> value should be written into.
top | Defines the {DOMElement} id where the top <OpenLayers.Bounds> value should be written into.
bottom | Defines the {DOMElement} id where the bottom <OpenLayers.Bounds> value should be written into.

### Properties

### QName

The qualified name for this control. Needed by XML config to instantiate it.

### opacity

{Number} | A numeric value which defined the opacity of drawn selection box. Must be between 0 and 1. If a non parsable value is specified the default value of the control will been used.

#### See Also

Legato.Control.SelectionBoxValueProvider.defaultOpacity

### layerName

{String} | Optional Parameter which defines the name of SelectionBox layer. If not specified

#### See Also

<Legato.Control.SelectionBoxValueProvider.defaultLayerName>

### left

Defines the {DOMElement} id where the left <OpenLayers.Bounds> value should be written into. The DOMElement must exists in current DOM. Otherwise an Exception is thrown.

### right

Defines the {DOMElement} id where the right <OpenLayers.Bounds> value should be written into. The DOMElement must exists in current DOM. Otherwise an Exception is thrown.

### top

Defines the {DOMElement} id where the top <OpenLayers.Bounds> value should be written into. The DOMElement must exists in current DOM. Otherwise an Exception is thrown.

### bottom

Defines the {DOMElement} id where the bottom <OpenLayers.Bounds> value should be written into. The DOMElement must exists in current DOM. Otherwise an Exception is thrown.

> initialize : function( | options | )

Basic ctor

> destroy : function()

OpenLayer.Control

> draw: function()

OpenLayer.Control
Abstract base class for all Legato control classes
The qualified name for this control.
{Number} The default opacity value of the selectionbox layer.