Package com.esri.arcgisruntime.mapping.popup

Class MediaPopupElement

  • public final class MediaPopupElement
extends PopupElement
    Represents a pop-up element of type media that defines an individual or array of chart and/or image to display in a pop-up for a geoelement.
    Since:
    100.14.0
    See Also:
    PopupElement

    • Constructor Summary

      Constructors 
      Constructor Description
      MediaPopupElement​(java.lang.Iterable<PopupMedia> media)
      Creates a new media pop-up element with the given collection of PopupMedia.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Gets an optional string describing the element in detail.
      java.util.List<PopupMedia> getMedia()
      Gets a mutable list of PopupMedia that define images and charts displayed in the pop-up window.
      java.lang.String getTitle()
      Gets an optional string indicating what the element represents.
      void setDescription​(java.lang.String description)
      Sets a string describing the element in detail.
      void setTitle​(java.lang.String title)
      Sets a string indicating what the element represents.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • MediaPopupElement

        public MediaPopupElement​(java.lang.Iterable<PopupMedia> media)
        Creates a new media pop-up element with the given collection of PopupMedia.
        Parameters:
        media - a collection of PopupMedia that define images and charts displayed in the pop-up window. When an empty collection is passed, this element will display whatever is specified in the PopupDefinition.getMedia().
        Throws:
        java.lang.IllegalArgumentException - if media is null
        Since:
        100.14.0

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Gets an optional string describing the element in detail.
        Returns:
        an optional string describing the element in detail
        Since:
        100.14.0
        See Also:
        setDescription(String)

      • setDescription

        public void setDescription​(java.lang.String description)
        Sets a string describing the element in detail.
        Parameters:
        description - a string describing the element in detail
        Throws:
        java.lang.IllegalArgumentException - if description is null
        Since:
        100.14.0
        See Also:
        getDescription()

      • getMedia

        public java.util.List<PopupMedia> getMedia()
        Gets a mutable list of PopupMedia that define images and charts displayed in the pop-up window.
        Returns:
        a mutable list of PopupMedia that define images and charts displayed in the pop-up window
        Since:
        100.14.0

      • getTitle

        public java.lang.String getTitle()
        Gets an optional string indicating what the element represents.
        Returns:
        an optional string indicating what the element represents
        Since:
        100.14.0
        See Also:
        setTitle(String)

      • setTitle

        public void setTitle​(java.lang.String title)
        Sets a string indicating what the element represents.
        Parameters:
        title - a string indicating what the element represents
        Throws:
        java.lang.IllegalArgumentException - if title is null
        Since:
        100.14.0
        See Also:
        getTitle()