com.jwebmp.plugins.imagemap.IJQImageMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jwebmp-image-map-heatmap Show documentation
The JWebSwing implementation for Image Map HeatMap
There is a newer version: 1.2.2.1-jre17
Show newest version
/*
 * Copyright (C) 2017 GedMarc
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package com.jwebmp.plugins.imagemap;

import com.jwebmp.core.base.html.Area;
import com.jwebmp.core.base.html.Div;
import com.jwebmp.core.base.html.Image;
import com.jwebmp.core.base.html.Map;
import com.jwebmp.plugins.jqgradientlinear.JQGradientsLinearFeature;

/**
 * @author GedMarc
 * @since 27 Feb 2017
 */
public interface IJQImageMap
{

	/**
	 * Adds an area to the component
	 *
	 * @param area
	 *
	 * @return
	 */
	Area add(Area area);

	/**
	 * Adds a specified area to the image map
	 *
	 * @param areaName
	 * 		The name of the area
	 * @param polygonCoordinates
	 * 		The co-ordinates for the area
	 *
	 * @return True or false if added public Area addAreaToMap(String areaName, String polygonCoordinates) { Area a = new Area(ImageMapAreaShapes.Poly, polygonCoordinates);
	 * 		a.addAttribute(GlobalAttributes.Name, areaName); this.map.add(a); return a; }
	 */
	Area addAreaToMap(String areaName, String polygonCoordinates);

	/**
	 * Adds a specified area to the image map
	 *
	 * @param area
	 * 		The area to add
	 *
	 * @return Always True
	 */
	boolean addAreaToMap(Area area);

	/**
	 * Returns the default properties
	 *
	 * @return
	 */
	JQMapInteractiveFeature getDefaultProperties();

	/**
	 * Sets the default properties
	 *
	 * @param defaultProperties
	 */
	void setDefaultProperties(JQMapInteractiveFeature defaultProperties);

	/**
	 * getDisplay X Size
	 *
	 * @return
	 */
	int getDisplayXSize();

	/**
	 * getDisplay X size
	 *
	 * @param displayXSize
	 */
	void setDisplayXSize(int displayXSize);

	/**
	 * getDisplay Y size
	 *
	 * @return
	 */
	int getDisplayYSize();

	/**
	 * getDisplay Y size
	 *
	 * @param displayYSize
	 */
	void setDisplayYSize(int displayYSize);

	/**
	 * Returns the gradient feature or a new one
	 *
	 * @return
	 */
	JQGradientsLinearFeature getGradientFeature();

	/**
	 * Return the heat map options
	 *
	 * @return
	 */
	JQImageHeatMapFeature getHeatMapFeature();

	/**
	 * Returns the associated image
	 *
	 * @return
	 */
	Image getImage();

	/**
	 * Sets the associated image
	 *
	 * @param image
	 */
	void setImage(Image image);

	/**
	 * Image x size
	 *
	 * @return
	 */
	int getImageXSize();

	/**
	 * Image x size
	 *
	 * @param imageXSize
	 */
	void setImageXSize(int imageXSize);

	/**
	 * Image Y size
	 *
	 * @return
	 */
	int getImageYSize();

	/**
	 * Set image y size
	 *
	 * @param imageYSize
	 */
	void setImageYSize(int imageYSize);

	/**
	 * Gets the label head div
	 *
	 * @return
	 */
	Div getLabelHeadDiv();

	/**
	 * Sets the label div
	 *
	 * @param labelHeadDiv
	 */
	void setLabelHeadDiv(Div labelHeadDiv);

	/**
	 * Gets the actual labels
	 *
	 * @return
	 */
	Div getLabelsDiv();

	/**
	 * Sets the label div
	 *
	 * @param labelsDiv
	 */
	void setLabelsDiv(Div labelsDiv);

	/**
	 * Gets the legend div
	 *
	 * @return
	 */
	Div getLegendDiv();

	/**
	 * Sets the legend div
	 *
	 * @param legendDiv
	 */
	void setLegendDiv(Div legendDiv);

	/**
	 * Gets the legend feature
	 *
	 * @return
	 */
	JQMapLegendFeature getLegendFeature();

	/**
	 * Sets the legend div
	 *
	 * @param legendFeature
	 */
	void setLegendFeature(JQMapLegendFeature legendFeature);

	/**
	 * Return the current map object
	 *
	 * @return
	 */
	Map getMap();

	/**
	 * Sets the current map object
	 *
	 * @param map
	 */
	void setMap(Map map);

	/**
	 * Returns the Map Image URL
	 *
	 * @return
	 */
	String getMapImageUrl();

	/**
	 * Sets the map image url
	 *
	 * @param mapImageUrl
	 */
	void setMapImageUrl(String mapImageUrl);

	/**
	 * If this map is a heat map
	 *
	 * @return
	 */
	boolean isHeatmap();

	/**
	 * If this map is a heatmap
	 *
	 * @param heatmap
	 */
	void setHeatmap(boolean heatmap);

	/**
	 * If this map is interactive
	 *
	 * @return
	 */
	boolean isInteractive();

	/**
	 * If this map is interactive
	 *
	 * @param interactive
	 */
	void setInteractive(boolean interactive);

	/**
	 * Set is labeled
	 *
	 * @return
	 */
	boolean isLabeled();

	/**
	 * Set is labeled
	 *
	 * @param labeled
	 */
	void setLabeled(boolean labeled);

	/**
	 * If this map has a legend
	 *
	 * @return
	 */
	boolean isLegend();

	/**
	 * If this map has a legend
	 *
	 * @param legend
	 */
	void setLegend(boolean legend);

	/**
	 * If the ratio is currently configured for the screen
	 *
	 * @return
	 */
	boolean isRatioConfigured();

	/**
	 * Is value displayed
	 *
	 * @return
	 */
	boolean isValueDisplayed();

	/**
	 * Is value displayed
	 *
	 * @param valueDisplayed
	 */
	void setValueDisplayed(boolean valueDisplayed);

	void preConfigure();

}