Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.mapping.popup

Class AttachmentsPopupElement

java.lang.Object

com.esri.arcgisruntime.mapping.popup.PopupElement

com.esri.arcgisruntime.mapping.popup.AttachmentsPopupElement

All Implemented Interfaces:

JsonSerializable

public final class AttachmentsPopupElement
extends PopupElement

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

Constructors

Constructor	Description
AttachmentsPopupElement(PopupAttachmentsDisplayType displayType)	Creates a new attachments pop-up element with the given PopupAttachmentsDisplayType.

Method Summary

Modifier and Type	Method	Description
ListenableFuture<Void>	fetchAttachmentsAsync()	Fetches the Attachments from the Feature, creates PopupAttachments from them, and populates getAttachments().
List<PopupAttachment>	getAttachments()	Returns all the current attachments.
String	getDescription()	Gets a string value describing the element in detail.
PopupAttachmentsDisplayType	getDisplayType()	Returns the PopupAttachmentsDisplayType that indicates how to display the attachments.
String	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 the PopupAttachmentsDisplayType that indicates how to display the attachments.
void	setTitle(String title)	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

Methods inherited from class java.lang.Object

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

Constructor Details

AttachmentsPopupElement

public AttachmentsPopupElement(PopupAttachmentsDisplayType displayType)

Creates a new attachments pop-up element with the given PopupAttachmentsDisplayType.

Parameters:

displayType - indicates how to display the attachments

Throws:

IllegalArgumentException - if displayType is null

Since:

100.14.0

Method Details

getAttachments

public List<PopupAttachment> getAttachments()

Returns all the current attachments. Will be empty if attachments haven't yet been fetched or if PopupElement.isEvaluated() is false.

Returns:

returns all the current attachments

Since:

200.1.0

See Also:

• fetchAttachmentsAsync()

getDescription

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

setDescription

public void setDescription(String description)

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:

• getDescription()

getDisplayType

public PopupAttachmentsDisplayType getDisplayType()

Returns the PopupAttachmentsDisplayType that indicates how to display the attachments. If PopupAttachmentsDisplayType.LIST is specified, attachments show as links. If PopupAttachmentsDisplayType.PREVIEW is specified, attachments expand to the width of the pop-up. Setting the value to PopupAttachmentsDisplayType.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(PopupAttachmentsDisplayType)

setDisplayType

public void setDisplayType(PopupAttachmentsDisplayType displayType)

Sets the PopupAttachmentsDisplayType that indicates how to display the attachments. If PopupAttachmentsDisplayType.LIST is specified, attachments show as links. If PopupAttachmentsDisplayType.PREVIEW is specified, attachments expand to the width of the pop-up. Setting the value to PopupAttachmentsDisplayType.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:

• getDisplayType()

getTitle

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

setTitle

public void setTitle(String title)

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:

• getTitle()

fetchAttachmentsAsync

public ListenableFuture<Void> fetchAttachmentsAsync()

Fetches the Attachments from the Feature, creates PopupAttachments from them, and populates getAttachments().

If PopupElement.isEvaluated() is false, this method will have no effect.

Returns:

a ListenableFuture that has no return value

Since:

200.1.0