com.google.gwt.maps.client.overlay.PolygonOptions.java Source code

Introduction

Here is the source code for com.google.gwt.maps.client.overlay.PolygonOptions.java

Source

/*
 * Copyright 2008 Google Inc.
 * 
 * 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 com.google.gwt.maps.client.overlay;

import com.google.gwt.core.client.JavaScriptObject;

/**
 * Options to pass to the {@link Polygon} constructor.
 */
public class PolygonOptions extends JavaScriptObject {

    /**
     * Returns a new instance of the PolygonOptions object.
     * 
     * @param clickable pass <code>false</code> to make this polygon ignore
     *          clicks.
     * @return a new instance of the PolygonOptions object.
     */
    public static native PolygonOptions newInstance(boolean clickable) /*-{
                                                                       return {"clickable":clickable};
                                                                       }-*/;

    /**
     * Returns a new instance of the PolygonOptions object.
     * 
     * @return a new instance of the PolygonOptions object.
     */
    public static PolygonOptions newInstance() {
        return (PolygonOptions) createObject();
    }

    protected PolygonOptions() {
        // Protected constructor required for JS overlays.
    }

    /**
     * Toggles whether or not the polygon is clickable. The default value for this
     * option is true, i.e. if the option is not specified, the polygon will be
     * clickable.
     * 
     * @param clickable pass <code>false</code> to make this polygon not
     *          clickable.
     */
    public final native void setClickable(boolean clickable) /*-{
                                                             this.clickable = clickable;
                                                             }-*/;
}