com.gwidgets.api.leaflet.options.FitBoundsOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwty-leaflet Show documentation
a JsInterop wrapper for the Leaflet js library
The newest version!
/**
 *  Copyright 2016 G-Widgets
 *  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.gwidgets.api.leaflet.options;

import static jsinterop.annotations.JsPackage.GLOBAL;

import com.gwidgets.api.leaflet.L;
import com.gwidgets.api.leaflet.Point;

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


/**
 * The Class FitBoundsOptions.
 * 
 * @author Zakaria Amine
 */
@JsType(isNative = true, namespace = GLOBAL, name = "Object")
public class FitBoundsOptions {


	private FitBoundsOptions() {

	}

	@JsProperty
	private Point paddingTopLeft;
	
	@JsProperty
	private Point paddingBottomRight;
	
	@JsProperty
	private Point padding;
	
	@JsProperty
	private double maxZoom;
	
	/*****************************************
	********************************************/
	@JsProperty
    private boolean animate;
	/**********************************************
	*********************************************/
    
    /*****************************************
	********************************************/
	@JsProperty
    private double duration;
	/**********************************************
	*********************************************/
    
    /*****************************************
	********************************************/
	@JsProperty
    private double easeLinearity;
	/**********************************************
	*********************************************/
    /*****************************************
	********************************************/
	@JsProperty
    private boolean noMoveStart;
	/**********************************************
	*********************************************/
    

	/**
	 * Gets the maximum possible zoom to use.
	 *
	 * @return the max zoom
	 */
	@JsOverlay
	public final double getMaxZoom() {
		return this.maxZoom;
	}

	/**
	 * Gets the amount of padding in the top left corner of a map container that shouldn't be accounted for when setting the view to fit bounds. 
	 *
	 * @return the padding top left
	 */
	@JsOverlay
	public final Point getPaddingTopLeft() {
		return this.paddingTopLeft;
	}

	/**
	 * Gets the same for bottom right corner of the map.
	 *
	 * @return the padding bottom right
	 */
	@JsOverlay
	public final Point getPaddingBottomRight() {
		return this.paddingBottomRight;
	}

	/**
	 * Gets the equivalent of setting both top left and bottom right padding to the same value.
	 *
	 * @return the padding
	 */
	@JsOverlay
	public final Point getPadding() {
		return this.padding;
	}

	@JsOverlay
	public final boolean getAnimate() {
		return this.animate;
	}

	@JsOverlay
	public final double getDuration() {
		return this.duration;
	}
	
	@JsOverlay
	public final double getEaseLinearity() {
		return this.easeLinearity;
	}

	@JsOverlay
	public final boolean getNoMoveStart() {
		return this.noMoveStart;
	}

	/**
	 * The Class Builder.
	 */
	public static class Builder {

		private Point paddingTopLeft;

		private Point paddingBottomRight;

		private Point padding;

		private Double maxZoom;
		
	    private Boolean animate;

	    private Double duration;

	    private Double easeLinearity;

	    private Boolean noMoveStart;

		/**
		 * Instantiates a new builder.
		 */
		public Builder() {

		}

		/**
		 * Sets the amount of padding in the top left corner of a map container that shouldn't be accounted for when setting the view to fit bounds. Useful if you have some control overlays on the map like a sidebar and you don't want them to obscure objects you're zooming to.
		 * 

		 * default [0, 0]
		 * 
		 * @param paddingTopLeft the padding top left
		 * @return the builder
		 */
		public Builder paddingTopLeft(Point paddingTopLeft) {
			this.paddingTopLeft = paddingTopLeft;
			return this;
		}

		/**
		 * The same for bottom right corner of the map.
		 * 

		 * default [0, 0]
		 * 
		 * @param paddingBottomRight the padding bottom right
		 * @return the builder
		 */
		public Builder paddingBottomRight(Point paddingBottomRight) {
			this.paddingBottomRight = paddingBottomRight;
			return this;
		}

		/**
		 * Equivalent of setting both top left and bottom right padding to the same value.
		 * 

		 * default [0, 0]
		 * 
		 * @param padding the padding
		 * @return the builder
		 */
		public Builder padding(Point padding) {
			this.padding = padding;
			return this;
		}

		/**
		 * The maximum possible zoom to use.
		 * 

		 * default null
		 * 
		 * @param maxZoom the max zoom
		 * @return the builder
		 */
		public Builder maxZoom(Double maxZoom) {
			this.maxZoom = maxZoom;
			return this;
		}
		
		public Builder animate(Boolean animate){this.animate = animate; return this;}

	    public Builder duration(Double duration){this.duration = duration; return this;}

	    public Builder easeLinearity(Double easeLinearity){this.easeLinearity = easeLinearity; return this;}

	    public Builder noMoveStart(Boolean noMoveStart){this.noMoveStart = noMoveStart; return this;}

		/**
		 * Builds the FitBoundsOptions new instance
		 *
		 * @return the fit bounds options
		 */
		public FitBoundsOptions build() {
			FitBoundsOptions options = new FitBoundsOptions();
			if(this.paddingTopLeft != null)
			options.paddingTopLeft = this.paddingTopLeft;
			if(this.paddingBottomRight != null)
			options.paddingBottomRight = this.paddingBottomRight;
			if(this.padding != null)
			options.padding = this.padding;
			if(this.maxZoom != null)
			options.maxZoom = this.maxZoom;
			if(this.animate != null)
		    options.animate = this.animate;
			if(this.duration != null)
		    options.duration = this.duration;
			if(this.easeLinearity != null)
		    options.easeLinearity = this.easeLinearity;
			if(this.noMoveStart != null)
		    options.noMoveStart = this.noMoveStart;

			return options;
		}
	}
}