java.lang.Object
com.esri.arcgisruntime.mapping.popup.PopupField
Represents how a geoelement's attribute (field) should be displayed in a pop-up.
- Since:
- 100.0.0
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Type of input box editors see when editing the field in a pop-up. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the field name.Gets the format used to display the field.getLabel()
Gets the field label.Gets the type of input box editors see when editing the field.Gets a string providing editing an hint for editors of the field.boolean
Gets a flag indicating whether users can edit the field.boolean
Gets a flag indicating whether the field is visible in the pop-up.void
setEditable
(boolean editable) Sets a flag indicating whether users can edit the field.void
setFieldName
(String fieldName) Sets the field name.void
Sets the field label.void
setPopupFieldFormat
(PopupFieldFormat popupFieldFormat) Sets the format used to display the field.void
setStringFieldOption
(PopupField.StringFieldOption stringFieldOption) Sets the type of input box editors see when editing the field.void
setTooltip
(String tooltip) Sets a string providing an editing hint for editors of the field.void
setVisible
(boolean visible) Sets a flag indicating whether the field is visible in the pop-up.
-
Constructor Details
-
PopupField
public PopupField()Constructs an empty PopupField.- Since:
- 100.0.0
-
-
Method Details
-
getFieldName
Gets the field name.- Returns:
- the field name
- Since:
- 100.0.0
-
setFieldName
Sets the field name.- Parameters:
fieldName
- the field name- Since:
- 100.0.0
-
getLabel
Gets the field label.- Returns:
- the field label
- Since:
- 100.0.0
-
setLabel
Sets the field label.- Parameters:
label
- the field label- Since:
- 100.0.0
-
isEditable
public boolean isEditable()Gets a flag indicating whether users can edit the field.- Returns:
- true if users can edit the field; otherwise false
- Since:
- 100.0.0
-
setEditable
public void setEditable(boolean editable) Sets a flag indicating whether users can edit the field.- Parameters:
editable
- a boolean indicating whether users can edit the field- Since:
- 100.0.0
-
isVisible
public boolean isVisible()Gets a flag indicating whether the field is visible in the pop-up.- Returns:
- true if the field is visible in the pop-up; otherwise false
- Since:
- 100.0.0
-
setVisible
public void setVisible(boolean visible) Sets a flag indicating whether the field is visible in the pop-up.- Parameters:
visible
- a boolean indicating whether the field is visible- Since:
- 100.0.0
-
getTooltip
Gets a string providing editing an hint for editors of the field.- Returns:
- the field tooltip
- Since:
- 100.0.0
-
setTooltip
Sets a string providing an editing hint for editors of the field.- Parameters:
tooltip
- the field tooltip- Since:
- 100.0.0
-
getStringFieldOption
Gets the type of input box editors see when editing the field. Applies only to string fields.- Returns:
- the type of input box
- Since:
- 100.0.0
-
setStringFieldOption
Sets the type of input box editors see when editing the field. Applies only to string fields.- Parameters:
stringFieldOption
- the type of input box- Throws:
IllegalArgumentException
- if the stringFieldOption is null- Since:
- 100.0.0
-
getFormat
Gets the format used to display the field.- Returns:
- the format used to display the field
- Since:
- 100.0.0
-
setPopupFieldFormat
Sets the format used to display the field.- Parameters:
popupFieldFormat
- the format used to display the field- Throws:
IllegalArgumentException
- if the popupFieldFormat is null- Since:
- 100.0.0
-