Upstream
/
BlueMapAPI
mirror of https://github.com/BlueMap-Minecraft/BlueMapAPI.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Html-Marker

This commit is contained in:
Blue (Lukas Rieger) 2021-03-22 22:06:52 +01:00
parent 92948cfd86
commit cc62191c84
No known key found for this signature in database
GPG Key ID: 904C4995F9E1F800
1 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/main/java/de/bluecolored/bluemap/api/marker/HtmlMarker.java
View File

@ -30,11 +30,32 @@ import de.bluecolored.bluemap.api.BlueMapAPI;
public interface HtmlMarker extends Marker, DistanceRangedMarker {
/**
* Getter for the position (in pixels) where the icon is anchored to the map.
* Getter for the position (in pixels) where the html-element is anchored to the map.
* @return the anchor-position in pixels
*/
Vector2i getAnchor();
/**
* Sets the position (in pixels) where the html-element is anchored to the map.
* @param anchor the anchor-position in pixels
*/
void setAnchor(Vector2i anchor);
/**
* Sets the position (in pixels) where the html-element is anchored to the map.
* @param x the anchor-x-position in pixels
* @param y the anchor-y-position in pixels
*/
default void setAnchor(int x, int y) {
setAnchor(new Vector2i(x, y));
}
/**
* Getter for the html-code of this HTML marker
* @return the html-code
*/
String getHtml();
/**
* Sets the html for this {@link HtmlMarker}.
*
@ -43,7 +64,7 @@ public interface HtmlMarker extends Marker, DistanceRangedMarker {
* Make sure you escape all html-tags from possible user inputs to prevent possible <a href="https://en.wikipedia.org/wiki/Cross-site_scripting">XSS-Attacks</a> on the web-client!
* </p>
*
* @param html the html-element that will be inserted as the marker.
* @param html the html that will be inserted as the marker.
*/
void setHtml(String html);