Class SketchEditConfiguration
- java.lang.Object
- 
- com.esri.arcgisruntime.mapping.view.SketchEditConfiguration
 
- 
 public final class SketchEditConfiguration extends java.lang.ObjectDefines the edit capabilities of the SketchEditor in a sketching session.- Since:
- 100.3.0
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classSketchEditConfiguration.SketchVertexEditModeDefines how vertices respond to user interaction.
 - 
Constructor SummaryConstructors Constructor Description SketchEditConfiguration()Constructs a default SketchEditConfiguration.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description SketchEditConfiguration.SketchVertexEditModegetVertexEditMode()Gets the SketchVertexEditMode specifying what actions are permitted on vertices.booleanisAllowPartSelection()Indicates whether or not a part in a multipart geometry (multipoint, polyline or polygon) can be selected.booleanisContextMenuEnabled()Indicates whether or not the context menu should be displayed when users interact with a vertex or a part.booleanisRequireSelectionBeforeDrag()Indicates whether or not a vertex or a part must first be selected before it can be dragged.voidsetAllowPartSelection(boolean allowPartSelection)Sets whether or not a part in a multipart geometry (multipoint, polyline or polygon) can be selected.voidsetContextMenuEnabled(boolean contextMenuEnabled)Sets whether or not a context menu should be displayed when users interact with a vertex or a part.voidsetRequireSelectionBeforeDrag(boolean requireSelectionBeforeDrag)Sets whether or not a vertex or a part must first be selected before it can be dragged.voidsetVertexEditMode(SketchEditConfiguration.SketchVertexEditMode sketchVertexEditMode)Sets the SketchVertexEditMode specifying what actions are permitted on vertices.
 
- 
- 
- 
Method Detail- 
isAllowPartSelectionpublic 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
 
 - 
setAllowPartSelectionpublic 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
 
 - 
isContextMenuEnabledpublic 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
 
 - 
setContextMenuEnabledpublic 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
 
 - 
isRequireSelectionBeforeDragpublic 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
 
 - 
setRequireSelectionBeforeDragpublic 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
 
 - 
getVertexEditModepublic SketchEditConfiguration.SketchVertexEditMode getVertexEditMode() Gets the SketchVertexEditMode specifying what actions are permitted on vertices. The default mode isSketchEditConfiguration.SketchVertexEditMode.INTERACTION_EDIT.- Returns:
- the SketchVertexEditMode
- Since:
- 100.3.0
 
 - 
setVertexEditModepublic void setVertexEditMode(SketchEditConfiguration.SketchVertexEditMode sketchVertexEditMode) Sets the SketchVertexEditMode specifying what actions are permitted on vertices.- Parameters:
- sketchVertexEditMode- the SketchVertexEditMode
- Throws:
- java.lang.IllegalArgumentException- if sketchVertexEditMode is null
- Since:
- 100.3.0
 
 
- 
 
-