Package com.esri.arcgisruntime.mapping.popup

Class PopupField

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PopupField.StringFieldOption
      Type of input box editors see when editing the field in a pop-up.

    • Constructor Summary

      Constructors 
      Constructor Description
      PopupField()
      Constructs an empty PopupField.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getFieldName()
      Gets the field name.
      PopupFieldFormat getFormat()
      Gets the format used to display the field.
      java.lang.String getLabel()
      Gets the field label.
      PopupField.StringFieldOption getStringFieldOption()
      Gets the type of input box editors see when editing the field.
      java.lang.String getTooltip()
      Gets a string providing editing an hint for editors of the field.
      boolean isEditable()
      Gets a flag indicating whether users can edit the field.
      boolean isVisible()
      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​(java.lang.String fieldName)
      Sets the field name.
      void setLabel​(java.lang.String label)
      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​(java.lang.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.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PopupField

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

    • Method Detail

      • getFieldName

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

      • setFieldName

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

      • getLabel

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

      • setLabel

        public void setLabel​(java.lang.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 java.lang.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​(java.lang.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:
        java.lang.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:
        java.lang.IllegalArgumentException - if the popupFieldFormat is null
        Since:
        100.0.0