| Package | com.esri.ags.components |
| Class | public class Editor |
| Inheritance | Editor  spark.components.supportClasses.SkinnableComponent |
| Since : | ArcGIS API for Flex 2.0 |
Editing behaviors:
templatePicker if you need to change the TemplatePicker and/or its properties.See also
| Property | Defined By | ||
|---|---|---|---|
| addEnabled : Boolean
If true, allows adding features. | Editor | ||
| attributeInspector : AttributeInspector [read-only]
The attribute inspector used by the Editor. | Editor | ||
| createGeometryType : String [read-only]
The current geometry type based on the selected template. | Editor | ||
| createOptions : CreateOptions
Create Options for the editor, for example, should the Editor use "freehand" instead of the default "point-to-point" when drawing (creating) new features. | Editor | ||
| deleteEnabled : Boolean
If true, allows deleting features. | Editor | ||
| drawTool : DrawTool [read-only]
The draw tool used by the Editor. | Editor | ||
| editTool : EditTool [read-only]
The edit tool used by the Editor. | Editor | ||
| featureLayers : Array
Array of FeatureLayer instances. | Editor | ||
| geometryService : GeometryService
The geometry service that the editor is associated with. | Editor | ||
| map : Map
The Map that the editor is associated with. | Editor | ||
| showTemplateSwatchOnCursor : Boolean
If true, shows the swatch(selected template symbol) on cursor. | Editor | ||
| toolbarCutVisible : Boolean
If true, displays the "cut" (aka "split") button on the toolbar. | Editor | ||
| toolbarMergeVisible : Boolean
If true, displays the "merge" button on the toolbar. | Editor | ||
| toolbarReshapeVisible : Boolean
If true, displays the "reshape" button on the toolbar. | Editor | ||
| toolbarVisible : Boolean
If true, shows the "toolbar". | Editor | ||
| undoAndRedoItemLimit : int
The maximum number of undoable or redoable operations to track. | Editor | ||
| updateAttributesEnabled : Boolean
If true, allows updating attributes. | Editor | ||
| updateGeometryEnabled : Boolean
If true, allows updating geometries. | Editor | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new Editor. | Editor | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when an Editor operation fails. | Editor | |||
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
| Skin Part | Description | Defined By | ||
|---|---|---|---|---|
clearSelectionButton:spark.components.supportClasses.ButtonBase | Required: false Part Type: Static An optional skin part for clear selection button. | Editor | ||
cutButton:spark.components.supportClasses.ToggleButtonBase | Required: false Part Type: Static An optional skin part for cut operation button. | Editor | ||
deleteButton:spark.components.supportClasses.ButtonBase | Required: false Part Type: Static An optional skin part for delete button. | Editor | ||
drawDropDownList:spark.components.DropDownList | Required: false Part Type: Static An optional skin part for the draw drop down list. | Editor | ||
mergeButton:spark.components.supportClasses.ButtonBase | Required: false Part Type: Static An optional skin part for the merge operation button. | Editor | ||
operationCompleteLabel:spark.components.Label | Required: false Part Type: Static An optional skin part for the operation complete text. | Editor | ||
operationStartLabel:spark.components.Label | Required: false Part Type: Static An optional skin part for the operation start text. | Editor | ||
redoButton:spark.components.supportClasses.ButtonBase | Required: false Part Type: Static An optional skin part for the redo operation button. | Editor | ||
reshapeButton:spark.components.supportClasses.ToggleButtonBase | Required: false Part Type: Static An optional skin part for the reshape operation button. | Editor | ||
selectionDropDownList:spark.components.DropDownList | Required: false Part Type: Static An optional skin part for the selection drop down list. | Editor | ||
templatePicker:TemplatePicker | Required: false Part Type: Static A optional skin part for the template picker. Use this if you need to change the TemplatePicker and/or its properties | Editor | ||
undoButton:spark.components.supportClasses.ButtonBase | Required: false Part Type: Static An optional skin part for the undo operation button. | Editor | ||
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
| addEnabled | property |
addEnabled:Boolean| Since : | ArcGIS API for Flex 2.3 |
If true, allows adding features.
The default value is true.
This property can be used as the source for data binding.
public function get addEnabled():Boolean public function set addEnabled(value:Boolean):void| attributeInspector | property |
attributeInspector:AttributeInspector [read-only] The attribute inspector used by the Editor. Use this if you need to change the AttributeInspector and/or its properties.
public function get attributeInspector():AttributeInspector| createGeometryType | property |
createGeometryType:String [read-only] The current geometry type based on the selected template.
This property can be used as the source for data binding.
public function get createGeometryType():String| createOptions | property |
createOptions:CreateOptionsCreate Options for the editor, for example, should the Editor use "freehand" instead of the default "point-to-point" when drawing (creating) new features. Also determines what goes in the draw tool drop down in the toolbar.
When toolbarVisible is true, users can change the default. When toolbarVisible is false, the first draw tool is used (and end users cannot change it). The draw tool are listed in the order they are defined. To change the "default" draw tool, simply list it first.
This property can be used as the source for data binding.
public function get createOptions():CreateOptions public function set createOptions(value:CreateOptions):void| deleteEnabled | property |
deleteEnabled:Boolean| Since : | ArcGIS API for Flex 2.1 |
If true, allows deleting features.
The default value is true.
This property can be used as the source for data binding.
public function get deleteEnabled():Boolean public function set deleteEnabled(value:Boolean):void| drawTool | property |
drawTool:DrawTool [read-only] The draw tool used by the Editor. Use this if you need to change the DrawTool and/or its properties.
public function get drawTool():DrawTool| editTool | property |
editTool:EditTool [read-only] The edit tool used by the Editor. Use this if you need to change the EditTool and/or its properties.
public function get editTool():EditTool| featureLayers | property |
featureLayers:Array
Array of FeatureLayer instances.
This property can be used as the source for data binding.
public function get featureLayers():Array public function set featureLayers(value:Array):void| geometryService | property |
geometryService:GeometryServiceThe geometry service that the editor is associated with.
This property can be used as the source for data binding.
public function get geometryService():GeometryService public function set geometryService(value:GeometryService):void| map | property |
map:MapThe Map that the editor is associated with.
This property can be used as the source for data binding.
public function get map():Map public function set map(value:Map):void| showTemplateSwatchOnCursor | property |
showTemplateSwatchOnCursor:BooleanIf true, shows the swatch(selected template symbol) on cursor.
The default value is true.
This property can be used as the source for data binding.
public function get showTemplateSwatchOnCursor():Boolean public function set showTemplateSwatchOnCursor(value:Boolean):void| toolbarCutVisible | property |
toolbarCutVisible:BooleanIf true, displays the "cut" (aka "split") button on the toolbar. Don't forget to turn on the toolbar itself using the toolbarVisible property.
The default value is false.
This property can be used as the source for data binding.
public function get toolbarCutVisible():Boolean public function set toolbarCutVisible(value:Boolean):voidSee also
| toolbarMergeVisible | property |
toolbarMergeVisible:BooleanIf true, displays the "merge" button on the toolbar. Don't forget to turn on the toolbar itself using the toolbarVisible property.
The default value is false.
This property can be used as the source for data binding.
public function get toolbarMergeVisible():Boolean public function set toolbarMergeVisible(value:Boolean):voidSee also
| toolbarReshapeVisible | property |
toolbarReshapeVisible:BooleanIf true, displays the "reshape" button on the toolbar. Don't forget to turn on the toolbar itself using the toolbarVisible property.
The default value is false.
This property can be used as the source for data binding.
public function get toolbarReshapeVisible():Boolean public function set toolbarReshapeVisible(value:Boolean):voidSee also
| toolbarVisible | property |
toolbarVisible:BooleanIf true, shows the "toolbar". By default, the "toolbar" displays below the template picker, but you can change this with the skin parts.
The default value is false.
This property can be used as the source for data binding.
public function get toolbarVisible():Boolean public function set toolbarVisible(value:Boolean):void| undoAndRedoItemLimit | property |
undoAndRedoItemLimit:int| Since : | ArcGIS API for Flex 2.2 |
The maximum number of undoable or redoable operations to track. To disable the undo/redo function, set this value to 0.
The default value is 25.
This property can be used as the source for data binding.
public function get undoAndRedoItemLimit():int public function set undoAndRedoItemLimit(value:int):void| updateAttributesEnabled | property |
updateAttributesEnabled:Boolean| Since : | ArcGIS API for Flex 2.3 |
If true, allows updating attributes.
The default value is true.
This property can be used as the source for data binding.
public function get updateAttributesEnabled():Boolean public function set updateAttributesEnabled(value:Boolean):void| updateGeometryEnabled | property |
updateGeometryEnabled:Boolean| Since : | ArcGIS API for Flex 2.3 |
If true, allows updating geometries.
The default value is true.
This property can be used as the source for data binding.
public function get updateGeometryEnabled():Boolean public function set updateGeometryEnabled(value:Boolean):void| Editor | () | Constructor |
public function Editor(featureLayers:Array = null, map:Map = null, geometryService:GeometryService = null)Creates a new Editor.
ParametersfeatureLayers:Array (default = null) | |
map:Map (default = null) | |
geometryService:GeometryService (default = null) |
| fault | Event |
mx.rpc.events.FaultEventmx.rpc.events.FaultEvent.FAULTDispatched when an Editor operation fails.