public class TLsp2DPointListEditor extends ALspEditor
ILcd2DEditablePointList
objects in an ILspView
.
MOVE
operations, with
a POINT_INDEX
property.MOVE
operations,
without any additional properties.REMOVE_POINT
operations.INSERT_POINT
operations.TLspEditOperation
, generated by an edit handle (see description
of handles above), this editor performs different edit operations on the associated 2D point
list object. The images below illustrate the effect of the different handles. In each image the
gray color represents the previous state of the object and the red color represents the edited object:
|
||||||
![]() |
|
![]() |
|
![]() |
|
![]() |
Adding a first point | |
Adding a second point | |
Adding a third point | |
Adding a fourth point and finalizing the creation process |
Modifier and Type | Class and Description |
---|---|
static class |
TLsp2DPointListEditor.PropertyKeys
Defines keys used by the enclosing editor implementation to store properties in its edit
handles.
|
Constructor and Description |
---|
TLsp2DPointListEditor()
Creates a new
TLsp2DPointListEditor . |
Modifier and Type | Method and Description |
---|---|
boolean |
canEdit(TLspEditContext aContext)
|
protected ALspEditHandle |
createInsertPointHandle(ILcd2DEditablePointList aPointList,
TLspEditContext aContext)
Creates an edit handle that allows the user to insert points into the given point list.
|
protected ALspEditHandle |
createObjectTranslationHandle(ILcd2DEditablePointList aPointList,
TLspEditContext aContext)
Creates an edit handle that allows the user to translate the given shape.
|
protected ALspEditHandle |
createPointHandle(ILcd2DEditablePointList aPointList,
int aIndex,
TLspEditContext aContext)
Creates an edit handle for the point with index
aIndex of the given point list. |
protected ALspEditHandle |
createRemovePointHandle(ILcd2DEditablePointList aPointList,
int aIndex,
TLspEditContext aContext)
Creates a point removal handle for the point with index
aIndex of the given point list. |
protected TLspEditOperationResult |
editImpl(TLspEditOperation aOperation,
ELspInteractionStatus aInteractionStatus,
TLspEditContext aContext)
Called by the
edit method to edit the given object based on the given
edit operation . |
ALspEditHandle |
getCreateHandle(TLspEditContext aContext)
Returns a handle that is used to create the given object.
|
ELspCreationMode |
getCreationMode()
Returns how the editor behaves during creation.
|
List<ALspEditHandle> |
getEditHandles(TLspEditContext aContext)
Returns a set of handles for editing the given object.
|
void |
setCreationMode(ELspCreationMode aCreationMode)
Sets how the editor behaves during creation
|
canCopyGeometry, canPerformOperation, copyGeometrySFCT, edit, fireUndoableHappened
public TLsp2DPointListEditor()
TLsp2DPointListEditor
.
This constructor does not initialize any state.public boolean canEdit(TLspEditContext aContext)
canEdit
in interface ILspEditor
canEdit
in class ALspEditor
aContext
- provides context information to the editortrue
if the above conditions are met, false
otherwise.public List<ALspEditHandle> getEditHandles(TLspEditContext aContext)
edit
method. As a way to communicate with this method,
handles will copy their properties to the edit operation properties.
By default this editor delegates to the following methods:
It returns a list containing the handles returned by those methods. These methods are
added for convenience, so they can easily be overridden.
Note that for the point handles, it delegates multiple times to those methods with different
indices. The only exception is the insert point handle, which is only a single instance.
By default this method returns a list that is twice the size, plus two, of the size of
the pointlist.aContext
- provides context information such as the layer for which the object
is being editedTLspEditController
protected ALspEditHandle createObjectTranslationHandle(ILcd2DEditablePointList aPointList, TLspEditContext aContext)
TLspObjectTranslationHandle
.aPointList
- the point list for which the handle is createdaContext
- the current contextnull
if no handle is neededprotected ALspEditHandle createInsertPointHandle(ILcd2DEditablePointList aPointList, TLspEditContext aContext)
This handle generates a INSERT_POINT
operation, with a
TLspIndexedPointDescriptor
in the properties. This object
describes where the new point should be inserted, and at what index in the point list.
aPointList
- the point list for which the handle is createdaContext
- the current contextnull
if no handle is neededprotected ALspEditHandle createPointHandle(ILcd2DEditablePointList aPointList, int aIndex, TLspEditContext aContext)
aIndex
of the given point list.
By default this method returns a point drag handle that allows
the user to move the associated point to another location. A POINT_INDEX
property with the given index as value is set on the handle.aPointList
- the point list for which the handle is returnedaIndex
- the index of the point in the point list, for which the handle is createdaContext
- the current contextnull
if no handle is neededprotected ALspEditHandle createRemovePointHandle(ILcd2DEditablePointList aPointList, int aIndex, TLspEditContext aContext)
aIndex
of the given point list.
This handle generates a REMOVE_POINT
operation,
with a TLspIndexedPointDescriptor
in the properties to
denote which point should be removed.aPointList
- the point list for which the handle is returnedaIndex
- the index of the point in the point list, for which the handle is createdaContext
- the current contextnull
if no handle is neededpublic ALspEditHandle getCreateHandle(TLspEditContext aContext)
ALspCreateHandle
which is a specialized handle implementation used for creating an object.
By default, this method returns an ALspCreateHandle
capable of creating an ILcd2DEditablePointList
, as described in the class javadoc.aContext
- provides context information such as the layer for which the object
is being creatednull
if creation should not be allowed.ALspCreateHandle
,
TLspCreateController
public ELspCreationMode getCreationMode()
getCreateHandle(TLspEditContext)
to create point lists.public void setCreationMode(ELspCreationMode aCreationMode)
aCreationMode
- the ELspCreationModeprotected TLspEditOperationResult editImpl(TLspEditOperation aOperation, ELspInteractionStatus aInteractionStatus, TLspEditContext aContext)
edit
method to edit the given object based on the given
edit operation
.
Note that this method does not need to lock the model of the object, this already happens in the
edit
method.
By default, this editor can handle the following operations:
If any of the operations contains the POINT_INDEX
property, with an integer value, then this editor will only perform the operation on that particular point,
otherwise it will perform it on the entire point list.editImpl
in class ALspEditor
aOperation
- the event that contains the information on how to edit the objectaInteractionStatus
- aContext
- the edit contextSUCCESS
if the above conditions are met,
FAILED
otherwise. The invalidation
hint will be set if a point was added or removed.