Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.mapping.popup

Class PopupMedia

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

  • Property Details

  • Constructor Details

    • PopupMedia

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

  • Method Details

    • getTitle

      public 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(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:
      IllegalArgumentException - if the type is null
      Since:
      100.0.0

    • getCaption

      public 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(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

    • imageRefreshIntervalProperty

      public LongProperty imageRefreshIntervalProperty()
      The image refresh interval. This property is useful only for a pop-up media of type PopupMedia.Type.IMAGE.

      The refresh interval, in milliseconds. A refresh interval of 0 means never refresh. The default value is 0.

      Returns:
      the imageRefreshInterval property
      Since:
      200.1.0
      See Also:

    • getImageRefreshInterval

      public long getImageRefreshInterval()
      Gets the value of the imageRefreshInterval property.
      Property description:
      The image refresh interval. This property is useful only for a pop-up media of type PopupMedia.Type.IMAGE.

      The refresh interval, in milliseconds. A refresh interval of 0 means never refresh. The default value is 0.

      Returns:
      the value of the imageRefreshInterval property
      Since:
      200.1.0
      See Also:

    • setImageRefreshInterval

      public void setImageRefreshInterval(long imageRefreshInterval)
      Sets the value of the imageRefreshInterval property.
      Property description:
      The image refresh interval. This property is useful only for a pop-up media of type PopupMedia.Type.IMAGE.

      The refresh interval, in milliseconds. A refresh interval of 0 means never refresh. The default value is 0.

      Parameters:
      imageRefreshInterval - the value for the imageRefreshInterval property
      Since:
      200.1.0
      See Also:

    • 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:
      IllegalArgumentException - if the popupMediaValue is null
      Since:
      100.0.0