Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.mapping.view

Class SketchEditConfiguration

java.lang.Object
com.esri.arcgisruntime.mapping.view.SketchEditConfiguration
@Deprecated(since="200.2.0", forRemoval=true) public final class SketchEditConfiguration extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
since 200.2.0 along with SketchEditor. New development should use GeometryEditor instead. The InteractionConfiguration of a GeometryEditorTool provides similar functionality for GeometryEditor.
Defines the edit capabilities of the SketchEditor in a sketching session.
Since:
100.3.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    SketchEditConfiguration.SketchVertexEditMode
    Deprecated, for removal: This API element is subject to removal in a future version.
    Defines how vertices respond to user interaction.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SketchEditConfiguration()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructs a default SketchEditConfiguration.

  • Method Summary

    Modifier and Type
    Method
    Description
    SketchEditConfiguration.SketchVertexEditMode
    getVertexEditMode()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets the SketchVertexEditMode specifying what actions are permitted on vertices.
    boolean
    isAllowPartSelection()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Indicates whether or not a part in a multipart geometry (multipoint, polyline or polygon) can be selected.
    boolean
    isContextMenuEnabled()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Indicates whether or not the context menu should be displayed when users interact with a vertex or a part.
    boolean
    isRequireSelectionBeforeDrag()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Indicates whether or not a vertex or a part must first be selected before it can be dragged.
    void
    setAllowPartSelection(boolean allowPartSelection)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets whether or not a part in a multipart geometry (multipoint, polyline or polygon) can be selected.
    void
    setContextMenuEnabled(boolean contextMenuEnabled)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets whether or not a context menu should be displayed when users interact with a vertex or a part.
    void
    setRequireSelectionBeforeDrag(boolean requireSelectionBeforeDrag)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets whether or not a vertex or a part must first be selected before it can be dragged.
    void
    setVertexEditMode(SketchEditConfiguration.SketchVertexEditMode sketchVertexEditMode)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the SketchVertexEditMode specifying what actions are permitted on vertices.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SketchEditConfiguration

      public SketchEditConfiguration()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructs a default SketchEditConfiguration.
      Since:
      100.3.0

  • Method Details

    • isAllowPartSelection

      public boolean isAllowPartSelection()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

    • getVertexEditMode

      public SketchEditConfiguration.SketchVertexEditMode getVertexEditMode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the SketchVertexEditMode specifying what actions are permitted on vertices. The default mode is SketchEditConfiguration.SketchVertexEditMode.INTERACTION_EDIT.
      Returns:
      the SketchVertexEditMode
      Since:
      100.3.0

    • setVertexEditMode

      public void setVertexEditMode(SketchEditConfiguration.SketchVertexEditMode sketchVertexEditMode)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the SketchVertexEditMode specifying what actions are permitted on vertices.
      Parameters:
      sketchVertexEditMode - the SketchVertexEditMode
      Throws:
      IllegalArgumentException - if sketchVertexEditMode is null
      Since:
      100.3.0