Package com.esri.arcgisruntime.mapping.view

Class SketchEditConfiguration

  • public final class SketchEditConfiguration
extends Object
    Defines the edit capabilities of the SketchEditor in a sketching session.
    Since:
    100.3.0

    • Constructor Detail

      • SketchEditConfiguration

        public SketchEditConfiguration()
        Constructs a default SketchEditConfiguration.
        Since:
        100.3.0

    • Method Detail

      • isAllowPartSelection

        public boolean isAllowPartSelection()
        Indicates whether or not a part in a multipart geometry (multipoint, polyline or polygon) can be selected. The default value is true.
        Returns:
        true if a part can be selected, false otherwise
        Since:
        100.3.0

      • setAllowPartSelection

        public void setAllowPartSelection​(boolean allowPartSelection)
        Sets whether or not a part in a multipart geometry (multipoint, polyline or polygon) can be selected.
        Parameters:
        allowPartSelection - true to allow a part in a multipart geometry to be selected, false otherwise
        Since:
        100.3.0

      • isContextMenuEnabled

        public boolean isContextMenuEnabled()
        Indicates whether or not the context menu should be displayed when users interact with a vertex or a part. The default value is true.
        Returns:
        true if the context menu can be displayed, false otherwise
        Since:
        100.3.0

      • setContextMenuEnabled

        public void setContextMenuEnabled​(boolean contextMenuEnabled)
        Sets whether or not a context menu should be displayed when users interact with a vertex or a part.
        Parameters:
        contextMenuEnabled - true to allow the context menu to be displayed, false otherwise
        Since:
        100.3.0

      • isRequireSelectionBeforeDrag

        public boolean isRequireSelectionBeforeDrag()
        Indicates whether or not a vertex or a part must first be selected before it can be dragged. The default value is false.
        Returns:
        true if a vertex or a part must first be selected before it can be dragged, false otherwise
        Since:
        100.3.0

      • setRequireSelectionBeforeDrag

        public void setRequireSelectionBeforeDrag​(boolean requireSelectionBeforeDrag)
        Sets whether or not a vertex or a part must first be selected before it can be dragged.
        Parameters:
        requireSelectionBeforeDrag - true to set a vertex or a part must first be selected before it can be dragged
        Since:
        100.3.0

      • setVertexEditMode

        public void setVertexEditMode​(SketchEditConfiguration.SketchVertexEditMode sketchVertexEditMode)
        Sets the SketchVertexEditMode specifying what actions are permitted on vertices.
        Parameters:
        sketchVertexEditMode - the SketchVertexEditMode
        Throws:
        IllegalArgumentException - if sketchVertexEditMode is null
        Since:
        100.3.0