Class ComposedShapeEditor`Abstract`

Abstract base editor for "composed shapes". These are shapes with nested shapes, such as a shape list , a extruded shape.

All the shapes in the composed shape are moved together.

For the sub-shape Editor.

Since

2022.1

Hierarchy

Editor
- ComposedShapeEditor

Index

Constructors

Accessors

delegate shapeType

Methods

canEdit createTranslateHandle getCreateHandle getEditHandles getSubShape getSubShapeCount

Constructors

constructor

new ComposedShapeEditor(shapeType, delegate): ComposedShapeEditor
Constructs a new ComposedShapeEditor
Parameters
- shapeType: ShapeType
  The shape type that this editor supports, for use in canEdit
- delegate: Editor
  The editor to delegate to, to get sub-shape handles.
Returns ComposedShapeEditor
Overrides Editor.constructor

Accessors

`Protected` delegate

get delegate(): Editor
Returns the delegate, as passed into the constructor.

Returns Editor

`Protected` shapeType

get shapeType(): ShapeType
Returns the shape type, as passed into the constructor.

Returns ShapeType

Methods

canEdit

canEdit(context): boolean
Indicates whether this editor can edit the given context.
Parameters
- context: EditContext
Returns boolean
true if context.shape matches the shape type defined in the constructor, and the delegate can edit all subshapes.

Overrides Editor.canEdit

createTranslateHandle

createTranslateHandle(context): null | EditHandle
Creates the shape translation handle.

This is a handle that allows translation (moving) of an entire shape / feature.
Parameters
- context: EditContext
  The context to retrieve the shape translate handle for
Returns null | EditHandle
Overrides Editor.createTranslateHandle

getCreateHandle

getCreateHandle(context): null | EditHandle
Returns a handle that is used to create the given object.
Parameters
- context: EditContext
  the edit context
Returns null | EditHandle
an editing handle that is used to initialize the state of the object being created.

Overrides Editor.getCreateHandle

getEditHandles

getEditHandles(context): EditHandle[]
This method is called by EditController to retrieve the handles for editing.

For example, point list translation/insertion/deletion handles, handles to modify a circles center and radius,... By default, all editors include a shape translation handle.

This is also used for creation, when the "create-by-template" approach is used to create new shapes.
Parameters
- context: EditContext
  The context to retrieve the handles for.
Returns EditHandle[]
Overrides Editor.getEditHandles

`Abstract` getSubShape

getSubShape(shape, index): Shape
Returns the subshape at the given index.
Parameters
- shape: Shape
  The shape to get a subshape from
- index: number
  The index of the subshape
Returns Shape
See
- ShapeList.getShape
- ComplexPolygon.getPolygon

`Abstract` getSubShapeCount

getSubShapeCount(shape): number
Returns the number of sub-shapes of the given shape.
Parameters
- shape: Shape
  The shape to determine the number of sub-shapes for
Returns number
See
- ShapeList.shapeCount
- ComplexPolygon.polygonCount