com.google.gwt.maps.client.controls.ScaleControlOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-maps-api Show documentation
There is a newer version: 3.10.0-alpha-7
package com.google.gwt.maps.client.controls;

/*
 * #%L
 * GWT Maps API V3 - Core API
 * %%
 * Copyright (C) 2011 - 2012 GWT Maps API V3
 * %%
 * 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.
 * #L%
 */

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

/**
 * Options for the rendering of the scale control. 

 * 

 * See 
 * ScaleControlOptions API Doc
 */
public class ScaleControlOptions extends JavaScriptObject {

  /**
   * Options for the rendering of the scale control.
   */
  protected ScaleControlOptions() {
  }

  /**
   * Options for the rendering of the scale control.
   * 
   * @return ScaleControlOptions
   */
  public final static ScaleControlOptions newInstance() {
    return JavaScriptObject.createObject().cast();
  }

  /**
   * Position id. Used to specify the position of the control on the map. The default position is TOP_LEFT.
   */
  public final ControlPosition getPosition() {
    return ControlPosition.fromValue(getPositionImpl());
  }

  private final native int getPositionImpl() /*-{
    return this.position;
  }-*/;

  /**
   * Position id. Used to specify the position of the control on the map. The default position is TOP_LEFT.
   * 
   * @param position {@link ControlPosition}
   */
  public final void setPosition(ControlPosition position) {
    setPositionImpl(position.value());
  }

  private final native void setPositionImpl(int position) /*-{
    this.position = position;
  }-*/;

  /**
   * set Style id. Used to select what style of scale control to display.
   * 
   * @param style {@link ScaleControlStyle}
   */
  public final void setStyle(ScaleControlStyle style) {
    setStyle(style.value());
  }

  /**
   * set Style id. Used to select what style of scale control to display.
   * 
   * @param style
   */
  private final native void setStyle(String style) /*-{
    this.style = style;
  }-*/;

  /**
   * get Style id. Used to select what style of scale control to display.
   * 
   * @return {@link ScaleControlStyle}
   */
  public final ScaleControlStyle getStyle() {
    return ScaleControlStyle.fromValue(getStyleJs());
  }

  /**
   * get Style id. Used to select what style of scale control to display.
   * 
   * @return String
   */
  private final native String getStyleJs() /*-{
    return this.style;
  }-*/;

}