|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.core.map.popup.PopupInfo
public class PopupInfo
The PopupInfo class represents popup definitions for features that need to be displayed in popups. Popup definitions contain information such as:
Constructor Summary | |
---|---|
PopupInfo()
Default constructor for PopupInfo. |
Method Summary | |
---|---|
static PopupInfo |
fromJson(org.codehaus.jackson.JsonParser parser)
Constructs a PopupInfo object from its JSON representation. |
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. |
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()
Returns the media as an array of PopupMediaInfo objects that is to be displayed in the popup. |
double |
getMinScale()
Returns the minimum scale that this popup should be shown at. |
String |
getTitle()
Returns the title of this popup. |
boolean |
isInitialized()
|
boolean |
isShowAttachments()
Returns true if this popup is configured to show attachments, false if otherwise. |
void |
setDescription(String description)
Sets the description of this popup. |
void |
setFieldInfos(PopupFieldInfo[] fieldInfos)
Sets a list of a graphic’s 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)
Sets the media that is to be displayed in the popup. |
void |
setMinScale(double minScale)
Sets the minimum scale that this popup should be shown at. |
void |
setShowAttachments(boolean showAttachments)
Set whether or not this popup should show attachments. |
void |
setTitle(String title)
Sets the title of this popup. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PopupInfo()
Method Detail |
---|
public double getMinScale()
public void setMinScale(double minScale)
minScale
- The minimum scale the popup should be shown atpublic double getMaxScale()
public void setMaxScale(double maxScale)
maxScale
- The maximum scale the popup should be shown atpublic String getTitle()
public void setTitle(String title)
title
- This popup's titlepublic String getDescription()
public void setDescription(String description)
description
- This popup's descriptionpublic PopupFieldInfo[] getFieldInfos()
public PopupFieldInfo getFieldInfo(String fieldName)
fieldName
- The name of the field to return.
public void setFieldInfos(PopupFieldInfo[] fieldInfos)
fieldInfos
- An array of PopupFieldInfo
s.public boolean isShowAttachments()
public void setShowAttachments(boolean showAttachments)
showAttachments
- True if attachments should be shown in the popup, false otherwisepublic PopupMediaInfo[] getMediaInfos()
public void setMediaInfos(PopupMediaInfo[] mediaInfos)
mediaInfos
- An array of PopupMediaInfo
s.public static PopupInfo fromJson(org.codehaus.jackson.JsonParser parser) throws Exception
parser
- A JSON parser object whose position is set at the "popupInfo" node.
PopupInfo
object.
Exception
- An exception that occurred during parsing.public boolean isInitialized()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |