public class

PopupFieldInfo

extends Object
java.lang.Object
   ↳ com.esri.core.map.popup.PopupFieldInfo

Class Overview

The PopupFieldInfo class defines information about how a graphic's attribute (field) should be displayed in a popup.

Summary

Public Constructors
PopupFieldInfo()
Public Methods
static PopupFieldInfo fromJson(JsonParser parser)
Constructs a PopupFieldInfo object from its JSON representation.
String getFieldName()
Returns the popup field's name.
PopupFormatValue getFormat()
Returns the format of the field.
String getLabel()
Returns the popup field's label.
String getTooltip()
Returns the popup field's tooltip.
boolean isEditable()
Returns true if this field is allowed to be modified and shown in a PopupView in the editing mode.
boolean isVisible()
Returns true if this field is shown in a PopupView in the viewing mode.
void setEditable(boolean isEditable)
Sets the editability of this field.
void setFieldName(String fieldName)
Sets the popup field's name.
void setFormat(PopupFormatValue format)
Sets the popup field's format from a PopupFormatValue.
void setLabel(String label)
Sets the popup field's label.
void setTooltip(String tooltip)
Sets the popup field's tooltip.
void setVisible(boolean visible)
Sets the visibility of this field.
String toJson()
Serializes a PopupFieldInfo object into a JSON String.
String toString()
Returns string representation of the class.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PopupFieldInfo ()

Public Methods

public static PopupFieldInfo fromJson (JsonParser parser)

Constructs a PopupFieldInfo object from its JSON representation.

Parameters
parser JsonParser: A JSON parser object whose position is set at the "fieldInfos" node.
Returns
PopupFieldInfo A PopupFieldInfo object.
Throws
Exception An exception that occurred during parsing.

public String getFieldName ()

Returns the popup field's name.

Returns
String fieldName

public PopupFormatValue getFormat ()

Returns the format of the field.

Returns
PopupFormatValue format

public String getLabel ()

Returns the popup field's label.

Returns
String label

public String getTooltip ()

Returns the popup field's tooltip.

Returns
String tooltip

public boolean isEditable ()

Returns true if this field is allowed to be modified and shown in a PopupView in the editing mode. Otherwise it is false.

Returns
boolean true if this field is allowed to be modified and shown in a PopupView in the editing mode, false otheriwse

public boolean isVisible ()

Returns true if this field is shown in a PopupView in the viewing mode. Otherwise it is false.

Returns
boolean true if this field is shown in a PopupView in the viewing mode, false otherwise.

public void setEditable (boolean isEditable)

Sets the editability of this field.

Parameters
isEditable boolean: True if the field should be editable, false otherwise

public void setFieldName (String fieldName)

Sets the popup field's name.

Parameters
fieldName String: The name of the field

public void setFormat (PopupFormatValue format)

Sets the popup field's format from a PopupFormatValue.

Parameters
format PopupFormatValue: The PopupFormatValue of the field

public void setLabel (String label)

Sets the popup field's label.

Parameters
label String: The label of the field

public void setTooltip (String tooltip)

Sets the popup field's tooltip.

Parameters
tooltip String: The tool tip of the field

public void setVisible (boolean visible)

Sets the visibility of this field.

Parameters
visible boolean: True if the field should be visible, false otherwise

public String toJson ()

Serializes a PopupFieldInfo object into a JSON String.

Returns
String a JSON String representing the PopupFieldInfo.
Throws
Exception An exception thrown the object cannot be serialized into JSON string.

public String toString ()

Returns string representation of the class. The format and content of the returned string is not part of the contract of the method and is subject to change in any future release or patch without further notice.

Returns
String