java.lang.Object
com.esri.arcgisruntime.mapping.popup.PopupFieldFormat
Represents the formatting of a field when used in the application.
Applies only to fields of type date or number (float, double, integer).
- Since:
- 100.0.0
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Format of a date field in a pop-up. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the format used to display a date field in a pop-up.long
Gets the number of supported decimal places that should appear for displaying a numerical field in a pop-up.boolean
Gets a flag indicating whether a numerical field may use the thousands (or digit) separator when the field is displayed in a pop-up.void
setDateFormat
(PopupFieldFormat.DateFormat dateFormat) Sets the format used to display a date field in a pop-up.void
setDecimalPlaces
(long decimalPlaces) Sets the number of supported decimal places that should appear for displaying a numerical field in a pop-up.void
setUseThousandsSeparator
(boolean useThousandsSeparator) Sets a flag indicating whether a numerical field may use the thousands (or digit) separator when the field is displayed in a pop-up.
-
Constructor Details
-
PopupFieldFormat
public PopupFieldFormat()Constructs an empty PopupFieldFormat.- Since:
- 100.0.0
-
-
Method Details
-
getDateFormat
Gets the format used to display a date field in a pop-up.- Returns:
- the format used to display a date field in a pop-up
- Since:
- 100.0.0
-
setDateFormat
Sets the format used to display a date field in a pop-up.- Parameters:
dateFormat
- the format used to display a date field in a pop-up- Throws:
IllegalArgumentException
- if the dateFormat is null- Since:
- 100.0.0
-
isUseThousandsSeparator
public boolean isUseThousandsSeparator()Gets a flag indicating whether a numerical field may use the thousands (or digit) separator when the field is displayed in a pop-up.- Returns:
- true if a field may use the thousands separator; otherwise false
- Since:
- 100.0.0
-
setUseThousandsSeparator
public void setUseThousandsSeparator(boolean useThousandsSeparator) Sets a flag indicating whether a numerical field may use the thousands (or digit) separator when the field is displayed in a pop-up.- Parameters:
useThousandsSeparator
- a boolean indicating whether a field may use the thousands separator- Since:
- 100.0.0
-
getDecimalPlaces
public long getDecimalPlaces()Gets the number of supported decimal places that should appear for displaying a numerical field in a pop-up.- Returns:
- the number of supported decimal places
- Since:
- 100.0.0
-
setDecimalPlaces
public void setDecimalPlaces(long decimalPlaces) Sets the number of supported decimal places that should appear for displaying a numerical field in a pop-up. Any places beyond this value are rounded.- Parameters:
decimalPlaces
- the number of supported decimal places- Since:
- 100.0.0
-