Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.mapping.popup

Class RelationshipPopupElement

java.lang.Object
com.esri.arcgisruntime.mapping.popup.PopupElement
com.esri.arcgisruntime.mapping.popup.RelationshipPopupElement
All Implemented Interfaces:
JsonSerializable
public final class RelationshipPopupElement extends PopupElement
Represents a pop-up element of type relationship that is displayed in a pop-up for a geoelement.

A typical UI implementation displays a preview of a maximum of display count related records with a possibility to show more records and more detailed info by record.

Since:
200.1.0

  • Property Details

    • description

      public StringProperty descriptionProperty
      A string value describing the element in detail. Can be an empty string.

      Will throw NullPointerException if the description is set to null.

      Since:
      200.1.0
      See Also:

    • displayCount

      public IntegerProperty displayCountProperty
      The maximum number of records to display.

      The default value is 3.

      If this maximum number is 0, no records will be displayed in the preview.

      Since:
      200.1.0
      See Also:

    • relationshipId

      public ReadOnlyLongProperty relationshipIdProperty
      The id of the relationship as defined in the feature layer definition.
      Since:
      200.1.0
      See Also:

    • title

      public StringProperty titleProperty
      A string value indicating what the element represents. Can be an empty string.

      Will throw NullPointerException if the title is set to null.

      Since:
      200.1.0
      See Also:

  • Constructor Details

    • RelationshipPopupElement

      public RelationshipPopupElement(long relationshipId)
      Creates a new relationship pop-up element with the given relationship ID.
      Parameters:
      relationshipId - the id of the relationship as defined in the feature layer definition
      Since:
      200.1.0

  • Method Details

    • descriptionProperty

      public StringProperty descriptionProperty()
      A string value describing the element in detail. Can be an empty string.

      Will throw NullPointerException if the description is set to null.

      Since:
      200.1.0
      See Also:

    • getDescription

      public String getDescription()
      Gets the value of the property description.
      Property description:
      A string value describing the element in detail. Can be an empty string.

      Will throw NullPointerException if the description is set to null.

      Since:
      200.1.0

    • setDescription

      public void setDescription(String description)
      Sets the value of the property description.
      Property description:
      A string value describing the element in detail. Can be an empty string.

      Will throw NullPointerException if the description is set to null.

      Since:
      200.1.0

    • displayCountProperty

      public IntegerProperty displayCountProperty()
      The maximum number of records to display.

      The default value is 3.

      If this maximum number is 0, no records will be displayed in the preview.

      Since:
      200.1.0
      See Also:

    • getDisplayCount

      public int getDisplayCount()
      Gets the value of the property displayCount.
      Property description:
      The maximum number of records to display.

      The default value is 3.

      If this maximum number is 0, no records will be displayed in the preview.

      Since:
      200.1.0

    • setDisplayCount

      public void setDisplayCount(int displayCount)
      Sets the value of the property displayCount.
      Property description:
      The maximum number of records to display.

      The default value is 3.

      If this maximum number is 0, no records will be displayed in the preview.

      Since:
      200.1.0

    • getOrderByFields

      public List<QueryParameters.OrderBy> getOrderByFields()
      Gets a List of QueryParameters.OrderBy objects indicating the display order for the related records and whether they should be sorted in ascending or descending order.

      If this collection is empty, the related records are displayed in whatever order the server decides.

      Returns:
      a List of QueryParameters.OrderBy objects indicating the display order for the related records and whether they should be sorted in ascending or descending order
      Since:
      200.1.0
      See Also:

    • relationshipIdProperty

      public ReadOnlyLongProperty relationshipIdProperty()
      The id of the relationship as defined in the feature layer definition.
      Since:
      200.1.0
      See Also:

    • getRelationshipId

      public long getRelationshipId()
      Gets the value of the property relationshipId.
      Property description:
      The id of the relationship as defined in the feature layer definition.
      Since:
      200.1.0

    • titleProperty

      public StringProperty titleProperty()
      A string value indicating what the element represents. Can be an empty string.

      Will throw NullPointerException if the title is set to null.

      Since:
      200.1.0
      See Also:

    • getTitle

      public String getTitle()
      Gets the value of the property title.
      Property description:
      A string value indicating what the element represents. Can be an empty string.

      Will throw NullPointerException if the title is set to null.

      Since:
      200.1.0

    • setTitle

      public void setTitle(String title)
      Sets the value of the property title.
      Property description:
      A string value indicating what the element represents. Can be an empty string.

      Will throw NullPointerException if the title is set to null.

      Since:
      200.1.0