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

Go to download
/**
 *
 *   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.RenderIntent;
import org.gwtopenmaps.openlayers.client.control.SelectFeature.ClickFeatureListener;
import org.gwtopenmaps.openlayers.client.control.SelectFeature.SelectFeatureListener;
import org.gwtopenmaps.openlayers.client.control.SelectFeature.UnselectFeatureListener;
import org.gwtopenmaps.openlayers.client.event.EventType;
import org.gwtopenmaps.openlayers.client.util.JSObject;

/**
 * See {@link SelectFeature}.
 *
 * Default mode of selection is clickout, see {@link SelectFeature}.
 *
 * @author Edwin Commandeur - Atlis EJS
 * @author Rafael Ceravolo - LOGANN
 *
 */
public class SelectFeatureOptions extends ControlOptions {

    /**
     * Indicates that the selection of the feature should occur when the mouse
     * hovers the feature rather then when clicked. Defaults to false.
     * 
     * Note: the behavior of the selection on hover depends also of the
     * highlightOnly property
     */
    public void setHover() {
        getJSObject().setProperty("hover", true);
    }

    /**
     * Indicates that when clicking a already selected feature again, it will be
     * unselected. Defaults to false.
     */
    public void setToggle() {
        getJSObject().setProperty("toggle", true);
    }

    /**
     * Indicates that the user can select multiple features at the same time.
     * Defaults to false.
     */
    public void setMultiple() {
        getJSObject().setProperty("multiple", true);
    }

    /**
     * Triggers when a feature is selected.
     *
     * TODO: Can this be added to SelectFeature? Or should it be set at construction time?
     * it doesn't work via event object, so removeListener will not work
     * the name should therefore not be addSelectFeature...
     */
    public void onSelect(SelectFeatureListener listener) {
        JSObject callback = SelectFeatureImpl.createSelectFeatureCallback(listener);
        getJSObject().setProperty(EventType.CONTROL_SELECT_FEATURE_SELECT, callback);
    }

    /**
     * Triggers when a feature is unselected.
     *
     * TODO: Can this be added to SelectFeature? Or should it be set at construction time?
     * it doesn't work via event object, so removeListener will not work
     * the name should therefore not be addUnSelectFeature...
     */
    public void onUnSelect(UnselectFeatureListener listener) {
        JSObject callback = SelectFeatureImpl.createUnselectFeatureCallback(listener);
        getJSObject().setProperty(EventType.CONTROL_SELECT_FEATURE_UNSELECT, callback);
    }

    /**
     * Triggers when a feature is clicked
     *
     * TODO: Same concern that for onSelect and onUnSelect ?
     */
    public void clickFeature(ClickFeatureListener listener) {
        JSObject callback = SelectFeatureImpl.createClickFeatureCallback(listener);
        getJSObject().setProperty("clickFeature", callback);
    }

    /**
     * From OpenLayers documentation: If true do not actually select features
     * (i.e. place them in the layer's selected features array), just highlight
     * them. This property has no effect if hover is false. Defaults to
     * false.
     *
     * @param highlightOnly
     *            The property value
     */
    public void setHighlightOnly(boolean highlightOnly) {
        getJSObject().setProperty("highlightOnly", highlightOnly);
    }

    /**
     * Sets the render intent of the styles to be used when drawing the features
     * on the selected state controled by the SelectFeature.Defaults to 
     * DEFAULT.
     *
     * @param renderIntent
     *            The render intent to be used
     */
    public void setRenderIntent(RenderIntent renderIntent) {
        if (renderIntent != null) {
            getJSObject().setProperty("renderIntent", renderIntent.getValue());
        }
    }

    /**
     * Allows features to be selected by dragging a box.
     */
    public void setBox(boolean box) {
        getJSObject().setProperty("box", box);
    }

}