Package com.esri.arcgisruntime.mapping.popup

Class AttachmentsPopupElement

java.lang.Object

com.esri.arcgisruntime.mapping.popup.PopupElement

com.esri.arcgisruntime.mapping.popup.AttachmentsPopupElement

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

See Also:

PopupElement

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
String	getDescription()	Gets an optional string describing the element in detail.
PopupAttachmentsDisplayType	getDisplayType()	Returns the PopupAttachmentsDisplayType that indicates how to display the attachments.
String	getTitle()	Gets an optional string indicating what the element represents.
void	setDescription(String description)	Sets a string 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 indicating what the element represents.

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

getDescription

public String getDescription()

Gets an optional string describing the element in detail.

Returns:

an optional string describing the element in detail

Since:

100.14.0

See Also:

setDescription(String)

setDescription

public void setDescription(String description)

Sets a string describing the element in detail.

Parameters:

description - a string describing the element in detail

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 an optional string indicating what the element represents.

Returns:

an optional string indicating what the element represents

Since:

100.14.0

See Also:

setTitle(String)

setTitle

public void setTitle(String title)

Sets a string indicating what the element represents.

Parameters:

title - a string indicating what the element represents

Throws:

IllegalArgumentException - if title is null

Since:

100.14.0

See Also:

getTitle()