com.esri.core.map.popup
Class PopupFieldInfo

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

public class PopupFieldInfo
extends Object

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

Since:

1.0

Constructor Summary

PopupFieldInfo()

Method Summary

static PopupFieldInfo	fromJson(org.codehaus.jackson.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

PopupFieldInfo

public PopupFieldInfo()

Method Detail

getFieldName

public String getFieldName()

Returns the popup field's name.

Returns:

fieldName

Since:

1.0

setFieldName

public void setFieldName(String fieldName)

Sets the popup field's name.

Parameters:

fieldName - The name of the field

Since:

1.0

getLabel

public String getLabel()

Returns the popup field's label.

Returns:

label

Since:

1.0

setLabel

public void setLabel(String label)

Sets the popup field's label.

Parameters:

label - The label of the field

Since:

1.0

getFormat

public PopupFormatValue getFormat()

Returns the format of the field.

Returns:

format

Since:

1.0

setFormat

public void setFormat(PopupFormatValue format)

Sets the popup field's format from a PopupFormatValue.

Parameters:

format - The PopupFormatValue of the field

Since:

1.0

isVisible

public boolean isVisible()

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

Returns:

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

Since:

1.0

setVisible

public void setVisible(boolean visible)

Sets the visibility of this field.

Parameters:

visible - True if the field should be visible, false otherwise

Since:

1.0

isEditable

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:

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

Since:

1.0

setEditable

public void setEditable(boolean isEditable)

Sets the editability of this field.

Parameters:

isEditable - True if the field should be editable, false otherwise

Since:

1.0

getTooltip

public String getTooltip()

Returns the popup field's tooltip.

Returns:

tooltip

Since:

1.0

setTooltip

public void setTooltip(String tooltip)

Sets the popup field's tooltip.

Parameters:

tooltip - The tool tip of the field

Since:

1.0

fromJson

public static PopupFieldInfo fromJson(org.codehaus.jackson.JsonParser parser)
                               throws Exception

Constructs a PopupFieldInfo object from its JSON representation.

Parameters:

parser - A JSON parser object whose position is set at the "fieldInfos" node.

Returns:

A PopupFieldInfo object.

Throws:

Exception - An exception that occurred during parsing.

Since:

1.0