com.jwebmp.plugins.imagemap.JQImageMap 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
Show all versions of jwebmp-image-map-heatmap Show documentation
The JWebSwing implementation for Image Map HeatMap
/*
* 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
*
* @author mmagon
* @version 0.1
* @since 2013/01/14
*/
@DisplayCSS(Position = Positions.Relative)
@ComponentInformation(name = "An image map that can be built for a url",
description = "An image map with selectable colour coded areas that can be determined from a series of values.",
url = "https://sourceforge.net/p/jwebswing/jquery-image-heatmap/ci/master/tree/")
public class JQImageMap
extends Component>
implements IJQImageMap
{
/**
* The default interactive feature
*/
private final JQImageHeatMapFeature heatMapFeature = new JQImageHeatMapFeature(this, 1, 1000000);
/**
* The labels div
*/
private Div labelsDiv;
/**
* The legend div
*/
private Div legendDiv;
/**
* The map
*/
private Map map;
/**
* The image
*/
private Image image;
/**
* The image x size
*/
private int imageXSize;
/**
* The image y size
*/
private int imageYSize;
/**
* The display x size
*/
private int displayXSize;
/**
* The display y size
*/
private int displayYSize;
/**
* The label head div
*/
private Div labelHeadDiv;
/**
* The default interactive feature
*/
private JQMapInteractiveFeature defaultProperties = new JQMapInteractiveFeature(this);
/**
* The gradient feature
*/
private JQGradientsLinearFeature gradientFeature;
/**
* The feature that will display the gradient legend
*/
private JQMapLegendFeature legendFeature = new JQMapLegendFeature(gradientFeature);
/**
* The map URL
*/
private String mapImageUrl;
/**
* Sets whether the image map should apply a heat map This attaches a heat map feature
*/
private boolean heatmap;
/**
* Shows whether the map is interactive Allows for highlighting
*/
private boolean interactive;
/**
* Shows whether the map is labeled This puts a div at the Center of each polygon
*/
private boolean labeled;
/**
* Sets whether to display a legend or not
*/
private boolean legend;
private boolean valueDisplayed;
private boolean ratioConfigured = false;
/**
* Constructs a new Image Map
*
* @param mapImageUrl
*/
public JQImageMap(String mapImageUrl)
{
this(mapImageUrl, false, false, false);
labelHeadDiv = new Div();
}
/**
* Constructs an ImageMap from the given parameters with the testing sizes
*
* @param mapImageUrl
* @param heatmap
* @param interactive
* @param labeled
*/
public JQImageMap(String mapImageUrl, boolean heatmap, boolean interactive, boolean labeled)
{
this(mapImageUrl, heatmap, interactive, labeled, 0, 0, 0, 0);
labelHeadDiv = new Div();
}
/**
* @param mapImageUrl
* @param heatmap
* @param interactive
* @param labeled
* @param imageXSize
* The original Image size
* @param imageYSize
* The original Image size
* @param displayXSize
* The new image x size
* @param displayYSize
* the new image y size
*/
@SuppressWarnings("unchecked")
public JQImageMap(String mapImageUrl, boolean heatmap, boolean interactive, boolean labeled, int imageXSize, int imageYSize, int displayXSize, int displayYSize)
{
super("div", ComponentTypes.Div, false);
labelHeadDiv = new Div();
this.imageXSize = imageXSize;
this.imageYSize = imageYSize;
this.displayYSize = displayYSize;
this.displayXSize = displayXSize;
this.mapImageUrl = mapImageUrl;
this.heatmap = heatmap;
this.interactive = interactive;
this.labeled = labeled;
map = new Map();
image = new Image(this.mapImageUrl);
defaultProperties.setDefaultProperties(true);
image.addAttribute(ImageAttributes.UseMap, StaticStrings.STRING_HASH + map.getID());
add(image);
add(map);
}
/**
* Adds an area to the component
*/
@Override
public Area add(Area area)
{
addAreaToMap(area);
return 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; }
*/
@Override
@SuppressWarnings("unchecked")
public Area addAreaToMap(String areaName, String polygonCoordinates)
{
HighlightedArea a = new HighlightedArea(ImageMapAreaShapes.Poly, polygonCoordinates);
a.addAttribute(GlobalAttributes.Name, areaName);
map.add(a);
return a;
}
/**
* Adds a specified area to the image map
*
* @param area
* The area to add
*
* @return Always True
*/
@Override
@SuppressWarnings("unchecked")
public boolean addAreaToMap(Area area)
{
map.add(area);
return true;
}
/**
* Returns the default properties
*
* @return
*/
@Override
public JQMapInteractiveFeature getDefaultProperties()
{
return defaultProperties;
}
/**
* Sets the default properties
*
* @param defaultProperties
*/
@Override
public void setDefaultProperties(JQMapInteractiveFeature defaultProperties)
{
this.defaultProperties = defaultProperties;
}
/**
* getDisplay X Size
*
* @return
*/
@Override
public int getDisplayXSize()
{
return displayXSize;
}
/**
* getDisplay X size
*
* @param displayXSize
*/
@Override
public void setDisplayXSize(int displayXSize)
{
this.displayXSize = displayXSize;
}
/**
* getDisplay Y size
*
* @return
*/
@Override
public int getDisplayYSize()
{
return displayYSize;
}
/**
* getDisplay Y size
*
* @param displayYSize
*/
@Override
public void setDisplayYSize(int displayYSize)
{
this.displayYSize = displayYSize;
}
/**
* Returns the gradient feature or a new one
*
* @return
*/
@Override
public JQGradientsLinearFeature getGradientFeature()
{
if (gradientFeature == null)
{
gradientFeature = new JQGradientsLinearFeature(this);
gradientFeature.getOptions()
.setDirection(Direction.Vertical);
gradientFeature.getOptions()
.setToColour(getHeatMapFeature().getColourMax());
gradientFeature.getOptions()
.setFromColour(getHeatMapFeature().getColourMin());
}
return gradientFeature;
}
/**
* Return the heat map options
*
* @return
*/
@Override
public JQImageHeatMapFeature getHeatMapFeature()
{
return heatMapFeature;
}
/**
* Returns the associated image
*
* @return
*/
@Override
public Image getImage()
{
return image;
}
/**
* Sets the associated image
*
* @param image
*/
@Override
public void setImage(Image image)
{
this.image = image;
}
/**
* Image x size
*
* @return
*/
@Override
public int getImageXSize()
{
return imageXSize;
}
/**
* Image x size
*
* @param imageXSize
*/
@Override
public void setImageXSize(int imageXSize)
{
this.imageXSize = imageXSize;
}
/**
* Image Y size
*
* @return
*/
@Override
public int getImageYSize()
{
return imageYSize;
}
/**
* Set image y size
*
* @param imageYSize
*/
@Override
public void setImageYSize(int imageYSize)
{
this.imageYSize = imageYSize;
}
/**
* Gets the label head div
*
* @return
*/
@Override
public Div getLabelHeadDiv()
{
return labelHeadDiv;
}
/**
* Sets the label div
*
* @param labelHeadDiv
*/
@Override
public void setLabelHeadDiv(Div labelHeadDiv)
{
this.labelHeadDiv = labelHeadDiv;
}
/**
* Gets the actual labels
*
* @return
*/
@Override
public Div getLabelsDiv()
{
return labelsDiv;
}
/**
* Sets the label div
*
* @param labelsDiv
*/
@Override
public void setLabelsDiv(Div labelsDiv)
{
this.labelsDiv = labelsDiv;
}
/**
* Gets the legend div
*
* @return
*/
@Override
public Div getLegendDiv()
{
return legendDiv;
}
/**
* Sets the legend div
*
* @param legendDiv
*/
@Override
public void setLegendDiv(Div legendDiv)
{
this.legendDiv = legendDiv;
}
/**
* Gets the legend feature
*
* @return
*/
@Override
public JQMapLegendFeature getLegendFeature()
{
return legendFeature;
}
/**
* Sets the legend div
*
* @param legendFeature
*/
@Override
public void setLegendFeature(JQMapLegendFeature legendFeature)
{
this.legendFeature = legendFeature;
}
/**
* Return the current map object
*
* @return
*/
@Override
@NotNull
public Map getMap()
{
return map;
}
/**
* Sets the current map object
*
* @param map
*/
@Override
public void setMap(Map map)
{
this.map = map;
}
/**
* Returns the Map Image URL
*
* @return
*/
@Override
public String getMapImageUrl()
{
return mapImageUrl;
}
/**
* Sets the map image url
*
* @param mapImageUrl
*/
@Override
public void setMapImageUrl(String mapImageUrl)
{
this.mapImageUrl = mapImageUrl;
}
/**
* If this map is a heat map
*
* @return
*/
@Override
public boolean isHeatmap()
{
return heatmap;
}
/**
* If this map is a heatmap
*
* @param heatmap
*/
@Override
public void setHeatmap(boolean heatmap)
{
this.heatmap = heatmap;
}
/**
* If this map is interactive
*
* @return
*/
@Override
public boolean isInteractive()
{
return interactive;
}
/**
* If this map is interactive
*
* @param interactive
*/
@Override
public void setInteractive(boolean interactive)
{
this.interactive = interactive;
if (isInteractive())
{
addFeature(defaultProperties);
}
else
{
removeFeature(defaultProperties);
}
}
/**
* Set is labeled
*
* @return
*/
@Override
public boolean isLabeled()
{
return labeled;
}
/**
* Set is labeled
*
* @param labeled
*/
@Override
public void setLabeled(boolean labeled)
{
this.labeled = labeled;
}
/**
* If this map has a legend
*
* @return
*/
@Override
public boolean isLegend()
{
return legend;
}
/**
* If this map has a legend
*
* @param legend
*/
@Override
public void setLegend(boolean legend)
{
this.legend = legend;
}
/**
* If the ratio is currently configured for the screen
*
* @return
*/
@Override
public boolean isRatioConfigured()
{
return ratioConfigured;
}
/**
* Is value displayed
*
* @return
*/
@Override
public boolean isValueDisplayed()
{
return valueDisplayed;
}
/**
* Is value displayed
*
* @param valueDisplayed
*/
@Override
public void setValueDisplayed(boolean valueDisplayed)
{
this.valueDisplayed = valueDisplayed;
}
/**
* Resizes accordingly
*/
@SuppressWarnings("unchecked")
public void renderResize()
{
if (displayXSize != 0)
{
image.addAttribute(ImageAttributes.Width, displayXSize + "px");
image.addAttribute(ImageAttributes.Height, displayYSize + "px");
int ratioXDifference = displayXSize / imageXSize;
int ratioYDifference = displayYSize / imageYSize;
int[] xArray;
int[] yArray;
if (!(ratioXDifference == 1 && ratioYDifference == 1) && !ratioConfigured)
{
ratioConfigured = true;
for (Iterator it = map.getChildren()
.iterator(); it.hasNext(); )
{
HighlightedArea area = (HighlightedArea) it.next();
int[][] allPoints = area.getCoordinatesArray();
xArray = new int[allPoints.length];
yArray = new int[allPoints.length];
for (int i = 0; i < allPoints.length; i++)
{
int[] is = allPoints[i];
xArray[i] = (is[0] * ratioXDifference);
yArray[i] = (is[1] * ratioYDifference);
}
StringBuilder coords = new StringBuilder();
for (int i = 0; i < xArray.length; i++)
{
int j = xArray[i];
int k = yArray[i];
coords.append(j + STRING_COMMNA + k + STRING_COMMNA);
}
coords = coords.deleteCharAt(coords.length() - 1);
area.setCoordinates(coords.toString());
}
}
}
}
@Override
@SuppressWarnings("unchecked")
public void preConfigure()
{
if (isInteractive())
{
addFeature(defaultProperties);
}
if (isHeatmap())
{
processHeatmap();
}
if ((isLabeled() || isValueDisplayed() && (!(getChildren().contains(labelHeadDiv)))))
{
processLabels();
}
for (Iterator it = map.getChildren()
.iterator(); it.hasNext(); )
{
HighlightedArea area = (HighlightedArea) it.next();
area.addAttribute(AreaAttributes.Data_MapHilight, "{" + area.getInteractiveProperties()
.getProperties(true) + "}");
}
super.preConfigure();
}
@SuppressWarnings("unchecked")
private void processHeatmap()
{
addFeature(defaultProperties);
addFeature(heatMapFeature);
if (isLegend())
{
getGradientFeature().getOptions()
.setFromColour(heatMapFeature.getColourMin());
getGradientFeature().getOptions()
.setToColour(heatMapFeature.getColourMax());
getGradientFeature().getOptions()
.setDirection(Direction.Vertical);
addFeature(legendFeature);
addFeature(gradientFeature);
getChildren().add(legendFeature.getLayoutDiv());
}
ArrayList values = new ArrayList();
for (Iterator it = map.getChildren()
.iterator(); it.hasNext(); )
{
HighlightedArea area = (HighlightedArea) it.next();
values.add(area.getValue());
}
heatMapFeature.setValues(values);
for (Iterator it = map.getChildren()
.iterator(); it.hasNext(); )
{
HighlightedArea area = (HighlightedArea) it.next();
area.getInteractiveProperties()
.addProperty(InteractiveFeatureProperties.overlayColorPermanent, heatMapFeature.getColourForValue(area.getValue()));
}
}
@SuppressWarnings("unchecked")
private void processLabels()
{
ArrayList alreadyAdded = new ArrayList();
for (Iterator it = map.getChildren()
.iterator(); it.hasNext(); )
{
HighlightedArea area = (HighlightedArea) it.next();
if (alreadyAdded.contains(area))
{
continue;
}
alreadyAdded.add(area);
Span areaLableDiv = new Span();
areaLableDiv.setText("");
areaLableDiv.addAttribute(GlobalAttributes.Style, "color:#000000 !important");
if (isLabeled())
{
areaLableDiv.setText(area.getAttribute(GlobalAttributes.Name));
}
if (isValueDisplayed())
{
areaLableDiv.setText(areaLableDiv.getText(0) + "
" + area.getPrettyValue());
}
areaLableDiv.addAttribute(GlobalAttributes.Style, "position:absolute");
areaLableDiv.addFeature(new Binder(areaLableDiv, area));
area.add(areaLableDiv);
}
}
/**
* Neater version
*
* @return
*/
public IJQImageMap asMe()
{
return this;
}
@Override
public int hashCode()
{
return super.hashCode();
}
@Override
public boolean equals(Object o)
{
return super.equals(o);
}
class Binder
extends Feature
{
Span label;
Area area;
public Binder(Span label, Area area)
{
super("Image Map Label Binder");
this.label = label;
this.area = area;
}
@Override
public int hashCode()
{
return super.hashCode();
}
@Override
public boolean equals(Object obj)
{
return super.equals(obj);
}
@Override
public void assignFunctionsToComponent()
{
addQuery("$('#" + label.getID() + "').bind('click', function(event) {$('#" + area.getID() + "').click();});");
addQuery("$('#" + label.getID() + "').bind('hover', function(event) {$('#" + area.getID() + "').hover();});");
addQuery("$('#" + label.getID() + "').bind('mouseover', function(event) {$('#" + area.getID() + "').mouseover();});");
addQuery("$('#" + label.getID() + "').bind('mouseout', function(event) {$('#" + area.getID() + "').mouseout();});");
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy