org.gwtopenmaps.openlayers.client.control.ModifyFeature Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-openlayers-client Show documentation
The newest version!
/**
 *
 *   Copyright 2015 sourceforge.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
/**
 *
 */
package org.gwtopenmaps.openlayers.client.control;

import org.gwtopenmaps.openlayers.client.Style;
import org.gwtopenmaps.openlayers.client.feature.VectorFeature;
import org.gwtopenmaps.openlayers.client.layer.Vector;
import org.gwtopenmaps.openlayers.client.util.JSObject;

/**
 * @author Edwin Commandeur - Atlis EJS
 *
 */
public class ModifyFeature extends Control {

    public static final int RESHAPE = 1;
    public static final int RESIZE = 2;
    public static final int ROTATE = 4;
    public static final int DRAG = 8;
    public static final String CLASS_NAME = "OpenLayers.Control.ModifyFeature";

    protected ModifyFeature(JSObject modifyFeature) {
        super(modifyFeature);
    }

    public ModifyFeature(Vector vectorLayer) {
        this(ModifyFeatureImpl.create(vectorLayer.getJSObject()));
    }

    public ModifyFeature(Vector vectorLayer,
            ModifyFeatureOptions modifyFeatureOptions) {
        this(ModifyFeatureImpl.create(vectorLayer.getJSObject(),
                modifyFeatureOptions.getJSObject()));
    }

    /**
     * Set the mode of the ModifyFeature. Can accept more than one mode at same
     * time.
     *
     * @param modes One or more modes to set to this ModifyFeature
     */
    public void setMode(int... modes) {

        int modeValue = 0;

        if (modes != null) {
            for (int mode : modes) {
                modeValue |= mode;
            }
        }

        this.getJSObject().setProperty("mode", modeValue);
    }

    /**
     * Property: modified {Boolean} The currently selected feature has been
     * modified.
     */
    public boolean isSelectedFeatureModified() {
        return ModifyFeatureImpl.isSelectedFeatureModified(getJSObject());
    }

    /**
     * Select a feature for modification in standalone mode. In non-standalone
     * mode, this method is called when the select feature control selects a
     * feature. Register a listener to the beforefeaturemodified event and
     * return false to prevent feature modification.
     *
     * @param feature - {} the selected feature.
     */
    public void selectFeature(VectorFeature feature) {
        ModifyFeatureImpl.selectFeature(getJSObject(), feature.getJSObject());
    }

    /**
     * Called when the select feature control unselects a feature.
     *
     * @param feature - {} The unselected feature.
     */
    public void unselectFeature(VectorFeature feature) {
        ModifyFeatureImpl.unselectFeature(getJSObject(), feature.getJSObject());
    }

    public void setVirtualStyle(Style virtualStyle) {
        getJSObject().setProperty("virtualStyle", virtualStyle.getJSObject());
    }

    @Override
    public Vector getLayer() {
        return Vector.narrowToLayer(getJSObject().getProperty("layer"));
    }

    /**
     *
     */
    public interface OnModificationStartListener {

        void onModificationStart(VectorFeature vectorFeature);
    }

    public interface OnModificationListener {

        void onModification(VectorFeature vectorFeature);
    }

    public interface OnModificationEndListener {

        void onModificationEnd(VectorFeature vectorFeature);
    }
}