Module com.esri.arcgisruntime
Class AttachmentsPopupElement
java.lang.Object
com.esri.arcgisruntime.mapping.popup.PopupElement
com.esri.arcgisruntime.mapping.popup.AttachmentsPopupElement
- All Implemented Interfaces:
JsonSerializable
Represents a pop-up element of type attachments that displays the attachments associated with a
geoelement in a pop-up. This element also specifies how to display the attachments.
- Since:
- 100.14.0
-
Property Summary
Properties inherited from class com.esri.arcgisruntime.mapping.popup.PopupElement
evaluated
-
Constructor Summary
ConstructorDescriptionAttachmentsPopupElement
(PopupAttachmentsDisplayType displayType) Creates a new attachments pop-up element with the givenPopupAttachmentsDisplayType
. -
Method Summary
Modifier and TypeMethodDescriptionFetches the Attachments from theFeature
, creates PopupAttachments from them, and populatesgetAttachments()
.Returns all the current attachments.Gets a string value describing the element in detail.Returns thePopupAttachmentsDisplayType
that indicates how to display the attachments.getTitle()
Gets a string value indicating what the element represents.void
setDescription
(String description) Sets a string value describing the element in detail.void
setDisplayType
(PopupAttachmentsDisplayType displayType) Sets thePopupAttachmentsDisplayType
that indicates how to display the attachments.void
Sets a string value indicating what the element represents.Methods inherited from class com.esri.arcgisruntime.mapping.popup.PopupElement
evaluatedProperty, fromJson, getUnknownJson, getUnsupportedJson, isEvaluated, toJson
-
Constructor Details
-
AttachmentsPopupElement
Creates a new attachments pop-up element with the givenPopupAttachmentsDisplayType
.- Parameters:
displayType
- indicates how to display the attachments- Throws:
IllegalArgumentException
- if displayType is null- Since:
- 100.14.0
-
-
Method Details
-
getAttachments
Returns all the current attachments. Will be empty if attachments haven't yet been fetched or ifPopupElement.isEvaluated()
is false.- Returns:
- returns all the current attachments
- Since:
- 200.1.0
- See Also:
-
getDescription
Gets a string value describing the element in detail. Can be an empty string.- Returns:
- a string value describing the element in detail. Can be an empty string.
- Since:
- 100.14.0
- See Also:
-
setDescription
Sets a string value describing the element in detail. Can be an empty string.- Parameters:
description
- a string value describing the element in detail. Can be an empty string.- Throws:
IllegalArgumentException
- if description is null- Since:
- 100.14.0
- See Also:
-
getDisplayType
Returns thePopupAttachmentsDisplayType
that indicates how to display the attachments. IfPopupAttachmentsDisplayType.LIST
is specified, attachments show as links. IfPopupAttachmentsDisplayType.PREVIEW
is specified, attachments expand to the width of the pop-up. Setting the value toPopupAttachmentsDisplayType.AUTO
allows applications to choose the most suitable default experience for their application.- Returns:
- the display type indicating how to display the attachments
- Since:
- 100.14.0
- See Also:
-
setDisplayType
Sets thePopupAttachmentsDisplayType
that indicates how to display the attachments. IfPopupAttachmentsDisplayType.LIST
is specified, attachments show as links. IfPopupAttachmentsDisplayType.PREVIEW
is specified, attachments expand to the width of the pop-up. Setting the value toPopupAttachmentsDisplayType.AUTO
allows applications to choose the most suitable default experience for their application.- Parameters:
displayType
- the display type indicating how to display the attachments- Throws:
IllegalArgumentException
- if displayType is null- Since:
- 100.14.0
- See Also:
-
getTitle
Gets a string value indicating what the element represents. Can be an empty string.- Returns:
- a string value indicating what the element represents. Can be an empty string.
- Since:
- 100.14.0
- See Also:
-
setTitle
Sets a string value indicating what the element represents. Can be an empty string.- Parameters:
title
- a string value indicating what the element represents. Can be an empty string.- Throws:
IllegalArgumentException
- if title is null- Since:
- 100.14.0
- See Also:
-
fetchAttachmentsAsync
Fetches the Attachments from theFeature
, creates PopupAttachments from them, and populatesgetAttachments()
.If
PopupElement.isEvaluated()
is false, this method will have no effect.- Returns:
- a
ListenableFuture
that has no return value - Since:
- 200.1.0
-