java.lang.Object
com.esri.arcgisruntime.mapping.popup.PopupMedia
Represents the media that is displayed in a pop-up for a geo-element.
- Since:
- 100.0.0
-
Property Summary
-
Nested Class Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the caption that is displayed for the media.long
Gets the value of theimageRefreshInterval
property.getTitle()
Gets the title that is displayed for the media.getType()
Gets the type of media.getValue()
Gets the optional media info value that is depending on the type of media.The image refresh interval.void
setCaption
(String caption) Sets the caption that is displayed for the media.void
setImageRefreshInterval
(long imageRefreshInterval) Sets the value of theimageRefreshInterval
property.void
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.
-
Property Details
-
imageRefreshInterval
The image refresh interval. This property is useful only for a pop-up media of typePopupMedia.Type.IMAGE
.The refresh interval, in milliseconds. A refresh interval of 0 means never refresh. The default value is 0.
- Since:
- 200.1.0
- See Also:
-
-
Constructor Details
-
PopupMedia
public PopupMedia()Constructs an empty PopupMedia.- Since:
- 100.0.0
-
-
Method Details
-
getTitle
Gets the title that is displayed for the media.- Returns:
- the title that is displayed for the media
- Since:
- 100.0.0
-
setTitle
Sets the title that is displayed for the media.- Parameters:
title
- the title that is displayed for the media- Since:
- 100.0.0
-
getType
Gets the type of media.- Returns:
- the type of media
- Since:
- 100.0.0
-
setType
Sets the type of media.- Parameters:
type
- the type of media- Throws:
IllegalArgumentException
- if the type is null- Since:
- 100.0.0
-
getCaption
Gets the caption that is displayed for the media.- Returns:
- the caption that is displayed for the media
- Since:
- 100.0.0
-
setCaption
Sets the caption that is displayed for the media.- Parameters:
caption
- the caption that is displayed for the media- Since:
- 100.0.0
-
imageRefreshIntervalProperty
The image refresh interval. This property is useful only for a pop-up media of typePopupMedia.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 theimageRefreshInterval
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 theimageRefreshInterval
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 theimageRefreshInterval
property- Since:
- 200.1.0
- See Also:
-
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
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
-