Package com.esri.arcgisruntime.mapping.popup

Class PopupMedia

  • public final class PopupMedia
extends java.lang.Object
    Represents the media that is displayed in a pop-up for a geo-element.
    Since:
    100.0.0

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PopupMedia.Type
      Type of media in a pop-up.

    • Constructor Summary

      Constructors 
      Constructor Description
      PopupMedia()
      Constructs an empty PopupMedia.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCaption()
      Gets the caption that is displayed for the media.
      java.lang.String getTitle()
      Gets the title that is displayed for the media.
      PopupMedia.Type getType()
      Gets the type of media.
      PopupMediaValue getValue()
      Gets the optional media info value that is depending on the type of media.
      void setCaption​(java.lang.String caption)
      Sets the caption that is displayed for the media.
      void setTitle​(java.lang.String title)
      Sets the title that is displayed for the media.
      void setType​(PopupMedia.Type type)
      Sets the type of media.
      void setValue​(PopupMediaValue popupMediaValue)
      Sets the optional media info value that is depending on the type of media.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PopupMedia

        public PopupMedia()
        Constructs an empty PopupMedia.
        Since:
        100.0.0

    • Method Detail

      • getTitle

        public java.lang.String getTitle()
        Gets the title that is displayed for the media.
        Returns:
        the title that is displayed for the media
        Since:
        100.0.0

      • setTitle

        public void setTitle​(java.lang.String title)
        Sets the title that is displayed for the media.
        Parameters:
        title - the title that is displayed for the media
        Since:
        100.0.0

      • getType

        public PopupMedia.Type getType()
        Gets the type of media.
        Returns:
        the type of media
        Since:
        100.0.0

      • setType

        public void setType​(PopupMedia.Type type)
        Sets the type of media.
        Parameters:
        type - the type of media
        Throws:
        java.lang.IllegalArgumentException - if the type is null
        Since:
        100.0.0

      • getCaption

        public java.lang.String getCaption()
        Gets the caption that is displayed for the media.
        Returns:
        the caption that is displayed for the media
        Since:
        100.0.0

      • setCaption

        public void setCaption​(java.lang.String caption)
        Sets the caption that is displayed for the media.
        Parameters:
        caption - the caption that is displayed for the media
        Since:
        100.0.0

      • getValue

        public PopupMediaValue getValue()
        Gets the optional media info value that is depending on the type of media.
        Returns:
        the optional media info value
        Since:
        100.0.0

      • setValue

        public void setValue​(PopupMediaValue popupMediaValue)
        Sets the optional media info value that is depending on the type of media.
        Parameters:
        popupMediaValue - the optional media info value
        Throws:
        java.lang.IllegalArgumentException - if the popupMediaValue is null
        Since:
        100.0.0