java.lang.Object | |
↳ | com.esri.core.map.popup.PopupInfo |
Known Direct Subclasses |
The PopupInfo class represents popup definitions for features that need to be displayed in popups. Popup definitions contain information such as:
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
protected String | description | ||||||||||
protected LinkedHashMap<String, PopupFieldInfo> | fieldInfos | ||||||||||
protected double | minScale | ||||||||||
protected String | title |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
PopupInfo(PopupInfo popupInfo) | |||||||||||
PopupInfo(Graphic graphic) | |||||||||||
PopupInfo()
Default constructor for PopupInfo.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
static PopupInfo |
fromJson(JsonParser parser)
@return
| ||||||||||
String |
getDescription()
Returns the description that is shown for the graphic in the popup.
| ||||||||||
PopupFieldInfo |
getFieldInfo(String fieldName)
Given a field name, returns the definition of how a graphic's field should be displayed in the popup.
| ||||||||||
Map<String, PopupFieldInfo> |
getFieldInfos()
Return an array of PopupFieldInfo objects which represent how a graphic's fields should be displayed in the popup.
| ||||||||||
double |
getMaxScale()
Returns the maximum scale that this popup should be shown at.
| ||||||||||
PopupMediaInfo[] | getMediaInfos() | ||||||||||
double |
getMinScale()
Returns the minimum scale that this popup should be shown at.
| ||||||||||
String |
getTitle()
Returns the title of this popup.
| ||||||||||
boolean | isShowAttachments() | ||||||||||
void |
setDescription(String description)
Sets the description of this popup.
| ||||||||||
void |
setFieldInfos(Map<String, PopupFieldInfo> fieldInfos)
Sets a list of a graphic fields to be displayed in the popup.
| ||||||||||
void |
setMaxScale(double maxScale)
Sets the maximum scale that this popup should be shown at.
| ||||||||||
void | setMediaInfos(PopupMediaInfo[] mediaInfos) | ||||||||||
void |
setMinScale(double minScale)
Sets the minimum scale that this popup should be shown at.
| ||||||||||
void | setShowAttachments(boolean showAttachments) | ||||||||||
void |
setTitle(String title)
Sets the title of this popup.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Default constructor for PopupInfo.
Returns the description that is shown for the graphic in the popup. This can be formatted as HTML. If the description is null then the PopupFieldInfos are used when viewing attributes. This can contain a literal value, or a placeholder for value from the graphic's attribute. The placeholder needs to be of the form {field_name} where field_name is a key in the graphic's attributes.
Given a field name, returns the definition of how a graphic's field should be displayed in the popup.
fieldName | The name of the field to return. |
---|
Return an array of PopupFieldInfo objects which represent how a graphic's fields should be displayed in the popup. If the description is null then the PopupFieldInfos are used when viewing attributes.
Returns the maximum scale that this popup should be shown at.
Returns the minimum scale that this popup should be shown at.
Sets the description of this popup.
description | This popup's description |
---|
Sets a list of a graphic fields to be displayed in the popup.
fieldInfos | An array of PopupFieldInfo s. |
---|
Sets the maximum scale that this popup should be shown at.
maxScale | The maximum scale the popup should be shown at |
---|
Sets the minimum scale that this popup should be shown at.
minScale | The minimum scale the popup should be shown at |
---|
showAttachments | the showAttachments to set |
---|
Sets the title of this popup.
title | This popup's title |
---|