package ol;

import com.google.gwt.dom.client.Element;

import jsinterop.annotations.JsProperty;
import jsinterop.annotations.JsType;

/**
 * {@link Overlay} options.
 * @author sbaumhekel
 *
 */
@JsType
public interface OverlayOptions extends Options {

    /**
     * If set to true the map is panned when calling setPosition, so that the
     * overlay is entirely visible in the current viewport. The default is
     * false.
     * @param autoPan
     *            auto pan?
     * @return this instance
     */
    @JsProperty
    void setAutoPan(boolean autoPan);

    /**
     * The margin (in pixels) between the overlay and the borders of the map
     * when autopanning. The default is 20.
     * @param autoPanMargin
     *            auto pan margin
     * @return this instance
     */
    @JsProperty
    void setAutoPanMargin(int autoPanMargin);

    /**
     * The overlay element.
     * @param element
     *            element
     * @return this instance
     */
    @JsProperty
    void setElement(Element element);

    /**
     * Set the overlay id. The overlay id can be used with the
     * ol.Map#getOverlayById method.
     * @param id
     *            id
     * @return this instance
     */
    @JsProperty
    void setId(String id);

    /**
     * Whether the overlay is inserted first in the overlay container, or
     * appended. Default is true. If the overlay is placed in the same container
     * as that of the controls (see the stopEvent option) you will probably set
     * insertFirst to true so the overlay is displayed below the controls.
     * @param insertFirst
     *            insert first?
     * @return this instance
     */
    @JsProperty
    void setInsertFirst(boolean insertFirst);

    /**
     * Offsets in pixels used when positioning the overlay. The first element in
     * the array is the horizontal offset. A positive value shifts the overlay
     * right. The second element in the array is the vertical offset. A positive
     * value shifts the overlay down. Default is [0, 0].
     * @param offset
     *            offset
     * @return this instance
     */
    @JsProperty
    void setOffset(Pixel offset);

    /**
     * The overlay position in map projection.
     * @param position
     *            position
     * @return this instance
     */
    @JsProperty
    void setPosition(Coordinate position);

    /**
     * Defines how the overlay is actually positioned with respect to its
     * position property. Possible values are 'bottom-left', 'bottom-center',
     * 'bottom-right', 'center-left', 'center-center', 'center-right',
     * 'top-left', 'top-center', and 'top-right'. Default is 'top-left'.
     * @param positioning
     *            positioning
     * @return this instance
     */
    @JsProperty
    void setPositioning(String positioning);

    /**
     * Whether event propagation to the map viewport should be stopped. Default
     * is true. If true the overlay is placed in the same container as that of
     * the controls (CSS class name ol-overlaycontainer-stopevent); if false it
     * is placed in the container with CSS class name ol-overlaycontainer.
     * @param stopEvent
     *            stop event propagation to the map viewport?
     * @return this instance
     */
    @JsProperty
    void setStopEvent(boolean stopEvent);

}

@@ -477,45 +477,16 @@
 an?%0A
-     * @return this instance%0A
      */%0A
     
@@ -473,32 +473,32 @@
 to pan?%0A     */%0A
+
     @JsProperty%0A
@@ -731,37 +731,8 @@
 gin%0A
-     * @return this instance%0A
     
@@ -886,37 +886,8 @@
 ent%0A
-     * @return this instance%0A
     
@@ -1095,37 +1095,8 @@
  id%0A
-     * @return this instance%0A
     
@@ -1523,37 +1523,8 @@
 st?%0A
-     * @return this instance%0A
     
@@ -1946,37 +1946,8 @@
 set%0A
-     * @return this instance%0A
     
@@ -2110,37 +2110,8 @@
 ion%0A
-     * @return this instance%0A
     
@@ -2538,37 +2538,8 @@
 ing%0A
-     * @return this instance%0A
     
@@ -2946,24 +2946,24 @@
 m stopEvent%0A
+
      *      
@@ -3016,37 +3016,8 @@
 rt?%0A
-     * @return this instance%0A
     

Correct Javadoc