Class Popup


  • public final class Popup
    extends Object
    Represents the combination of a PopupDefinition and a GeoElement, which allows a visual representation of the GeoElement's attributes as well as the ability to edit them.
    Since:
    100.0.0
    • Constructor Detail

      • Popup

        public Popup​(GeoElement geoElement)
        Instantiates a Popup with the provided GeoElement and a PopupDefinition based off the attributes of the GeoElement.
        Parameters:
        geoElement - the GeoElement on which to base the Popup
        Throws:
        IllegalArgumentException - if geoElement is null
        Since:
        100.0.0
      • Popup

        public Popup​(GeoElement geoElement,
                     PopupDefinition popupDefinition)
        Instantiates a Popup with the provided GeoElement and PopupDefinition. If the PopupDefinition is null, a new one will be created based off the attributes of the GeoElement.
        Parameters:
        geoElement - the GeoElement on which to base the Popup
        popupDefinition - the PopupDefinition
        Throws:
        IllegalArgumentException - if geoElement is null
        Since:
        100.0.0
    • Method Detail

      • getPopupDefinition

        public PopupDefinition getPopupDefinition()
        Gets the PopupDefinition.
        Returns:
        the PopupDefinition
        Since:
        100.0.0
      • getGeoElement

        public GeoElement getGeoElement()
        Gets the GeoElement.
        Returns:
        the GeoElement
        Since:
        100.0.0
      • getTitle

        public String getTitle()
        Gets the title of the Popup.
        Returns:
        the title of the Popup
        Since:
        100.0.0
      • getDescription

        public String getDescription()
        Gets the description of the Popup.
        Returns:
        the description of the Popup
        Since:
        100.0.0
      • getSymbol

        public Symbol getSymbol()
        Gets the symbol of the Popup.
        Returns:
        the symbol of the Popup
        Since:
        100.0.0
      • getFormattedValue

        public String getFormattedValue​(PopupField popupField)
        Gets the formatted value of the popup field.
        Parameters:
        popupField - the popup field
        Returns:
        the formatted string representing the value of the popup field
        Since:
        100.3.0