java.lang.Object
com.esri.arcgisruntime.mapping.popup.PopupElement
com.esri.arcgisruntime.mapping.popup.FieldsPopupElement
- All Implemented Interfaces:
JsonSerializable
Represents a pop-up element of type fields that defines an array of
PopupField
displayed
as a table within a pop-up for a geoelement.- Since:
- 100.14.0
-
Property Summary
Properties inherited from class com.esri.arcgisruntime.mapping.popup.PopupElement
evaluated
-
Constructor Summary
ConstructorDescriptionFieldsPopupElement
(Iterable<PopupField> fields) Creates a new fields pop-up element with the given collection ofPopupField
. -
Method Summary
Modifier and TypeMethodDescriptionGets a string value describing the element in detail.Gets a mutable list ofPopupField
defining how each field participates in the pop-up window.Gets the formatted values for the fields defined ingetFields()
.Gets the user-friendly display names for the fields defined ingetFields()
.getTitle()
Gets a string value indicating what the element represents.void
setDescription
(String description) Sets a string value describing the element in detail.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
-
FieldsPopupElement
Creates a new fields pop-up element with the given collection ofPopupField
.- Parameters:
fields
- a collection ofPopupField
defining how each field participates in the pop-up window. When an empty collection is passed, this element will display whatever is specified in thePopupDefinition.getFields()
.- Throws:
IllegalArgumentException
- if fields is null- Since:
- 100.14.0
-
-
Method Details
-
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:
-
getFields
Gets a mutable list ofPopupField
defining how each field participates in the pop-up window.- Returns:
- a mutable list of
PopupField
defining how each field participates in the pop-up window - Since:
- 100.14.0
-
getFormattedValues
Gets the formatted values for the fields defined ingetFields()
. This property is populated whenPopup.evaluateExpressionsAsync()
is called.Dates and times are returned in the local timezone.
If a field is part of a
CodedValueDomain
, theCodedValue.getName()
is returned.If
PopupElement.isEvaluated()
is false, this property will return an empty collection.- Returns:
- the formatted values for the fields defined in
FieldsPopupElement.getFields()
- Since:
- 200.1.0
-
getLabels
Gets the user-friendly display names for the fields defined ingetFields()
. This property is populated whenPopup.evaluateExpressionsAsync()
is called.If
PopupElement.isEvaluated()
is false, this property will return an empty collection.- Returns:
- the user-friendly display names for the fields defined in
FieldsPopupElement.getFields()
- Since:
- 200.1.0
-
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:
-