Class RelationshipPopupElement
- All Implemented Interfaces:
JsonSerializable
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 Summary
TypePropertyDescriptionA string value describing the element in detail.The maximum number of records to display.The id of the relationship as defined in the feature layer definition.A string value indicating what the element represents.Properties inherited from class com.esri.arcgisruntime.mapping.popup.PopupElement
evaluated
-
Constructor Summary
ConstructorDescriptionRelationshipPopupElement
(long relationshipId) Creates a new relationship pop-up element with the given relationship ID. -
Method Summary
Modifier and TypeMethodDescriptionA string value describing the element in detail.The maximum number of records to display.Gets the value of thedescription
property.int
Gets the value of thedisplayCount
property.Gets aList
ofQueryParameters.OrderBy
objects indicating the display order for the related records and whether they should be sorted in ascending or descending order.long
Gets the value of therelationshipId
property.getTitle()
Gets the value of thetitle
property.The id of the relationship as defined in the feature layer definition.void
setDescription
(String description) Sets the value of thedescription
property.void
setDisplayCount
(int displayCount) Sets the value of thedisplayCount
property.void
Sets the value of thetitle
property.A string value indicating what the element represents.Methods inherited from class com.esri.arcgisruntime.mapping.popup.PopupElement
evaluatedProperty, fromJson, getUnknownJson, getUnsupportedJson, isEvaluated, toJson
-
Property Details
-
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
- See Also:
-
displayCount
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
The id of the relationship as defined in the feature layer definition.- Since:
- 200.1.0
- See Also:
-
title
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
A string value describing the element in detail. Can be an empty string.Will throw NullPointerException if the description is set to null.
- Returns:
- the
description
property - Since:
- 200.1.0
- See Also:
-
getDescription
Gets the value of thedescription
property.- 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.
- Returns:
- the value of the
description
property - Since:
- 200.1.0
- See Also:
-
setDescription
Sets the value of thedescription
property.- 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.
- Parameters:
description
- the value for thedescription
property- Since:
- 200.1.0
- See Also:
-
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.
- Returns:
- the
displayCount
property - Since:
- 200.1.0
- See Also:
-
getDisplayCount
public int getDisplayCount()Gets the value of thedisplayCount
property.- 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.
- Returns:
- the value of the
displayCount
property - Since:
- 200.1.0
- See Also:
-
setDisplayCount
public void setDisplayCount(int displayCount) Sets the value of thedisplayCount
property.- 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.
- Parameters:
displayCount
- the value for thedisplayCount
property- Since:
- 200.1.0
- See Also:
-
getOrderByFields
Gets aList
ofQueryParameters.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
ofQueryParameters.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
The id of the relationship as defined in the feature layer definition.- Returns:
- the
relationshipId
property - Since:
- 200.1.0
- See Also:
-
getRelationshipId
public long getRelationshipId()Gets the value of therelationshipId
property.- Property description:
- The id of the relationship as defined in the feature layer definition.
- Returns:
- the value of the
relationshipId
property - Since:
- 200.1.0
- See Also:
-
titleProperty
A string value indicating what the element represents. Can be an empty string.Will throw NullPointerException if the title is set to null.
- Returns:
- the
title
property - Since:
- 200.1.0
- See Also:
-
getTitle
Gets the value of thetitle
property.- 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.
- Returns:
- the value of the
title
property - Since:
- 200.1.0
- See Also:
-
setTitle
Sets the value of thetitle
property.- 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.
- Parameters:
title
- the value for thetitle
property- Since:
- 200.1.0
- See Also:
-