Package com.esri.arcgisruntime.mapping.popup

Class PopupField

  • public final class PopupField
extends Object
    Represents how a geoelement's attribute (field) should be displayed in a pop-up.
    Since:
    100.0.0

    • Constructor Detail

      • PopupField

        public PopupField()
        Constructs an empty PopupField.
        Since:
        100.0.0

    • Method Detail

      • getFieldName

        public String getFieldName()
        Gets the field name.
        Returns:
        the field name
        Since:
        100.0.0

      • setFieldName

        public void setFieldName​(String fieldName)
        Sets the field name.
        Parameters:
        fieldName - the field name
        Since:
        100.0.0

      • getLabel

        public String getLabel()
        Gets the field label.
        Returns:
        the field label
        Since:
        100.0.0

      • setLabel

        public void setLabel​(String label)
        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

        public String getTooltip()
        Gets a string providing editing an hint for editors of the field.
        Returns:
        the field tooltip
        Since:
        100.0.0

      • setTooltip

        public void setTooltip​(String tooltip)
        Sets a string providing an editing hint for editors of the field.
        Parameters:
        tooltip - the field tooltip
        Since:
        100.0.0

      • getStringFieldOption

        public PopupField.StringFieldOption 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

        public void setStringFieldOption​(PopupField.StringFieldOption stringFieldOption)
        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

        public PopupFieldFormat getFormat()
        Gets the format used to display the field.
        Returns:
        the format used to display the field
        Since:
        100.0.0

      • setPopupFieldFormat

        public void setPopupFieldFormat​(PopupFieldFormat popupFieldFormat)
        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