Package com.esri.arcgisruntime.mapping.popup

Class TextPopupElement

java.lang.Object

com.esri.arcgisruntime.mapping.popup.PopupElement

com.esri.arcgisruntime.mapping.popup.TextPopupElement

public final class TextPopupElement
extends PopupElement

Represents a pop-up element of type text that defines descriptive text as an element to display in a pop-up for a geoelement. The text may reference values returned from a field attribute or an Arcade expression defined in the PopupDefinition.getExpressions(). The text may also leverage a basic subset of HTML tags for formatting the look and feel of the text.

Since:

100.14.0

See Also:

PopupElement

Constructor Summary

Constructors

Constructor	Description
TextPopupElement(java.lang.String text)	Creates a new text pop-up element with the given text.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getText()	Gets the text to display in the pop-up.
void	setText(java.lang.String text)	Sets the text to display in the pop-up.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextPopupElement

public TextPopupElement(java.lang.String text)

Creates a new text pop-up element with the given text. The text may reference values returned from a field attribute or an Arcade expression defined in the PopupDefinition.getExpressions(). The text may also leverage a basic subset of HTML tags for formatting the look and feel of the text.

Parameters:

text - a string indicating the text to be displayed within the pop-up element. If an empty string is provided, the pop-up element will display whatever is specified in the PopupDefinition.getDescription().

Throws:

java.lang.IllegalArgumentException - if text is null

Since:

100.14.0

Method Detail

getText

public java.lang.String getText()

Gets the text to display in the pop-up.

Returns:

the text to display in the pop-up

Since:

100.14.0

See Also:

setText(String)

setText

public void setText(java.lang.String text)

Sets the text to display in the pop-up.

Parameters:

text - the text to display in the pop-up

Throws:

java.lang.IllegalArgumentException - if text is null

Since:

100.14.0

See Also:

getText()