Class TLspComplexPolygonEditor

All Implemented Interfaces:

public class TLspComplexPolygonEditor extends ALspEditor
Enables visual editing of ILcdEditableComplexPolygon objects in an ILspView.


The complex polygon editor defines the following edit handles for a complex polygon:
  • Polygon handles: allows the user to edit the sub-polygons.
  • Object translation handle: allows the user to translate the entire complex polygon. This handle generates MOVE operations, with without any additional properties.


Based on the TLspEditOperation, generated by an edit handle (see description of handles above), this editor performs different edit operations on the associated complex polygon object. This editor only unwraps the polygons contained by the ILcdEditableComplexPolygon object that is being edited and delegates editing for those polygons to the TLsp2DPointListEditor.


The creation process of a complex polygon object consists of the creation of several polygons, see TLsp2DPointListEditor. A single polygon can be finished with a right-click, after which a new polygon can be created. The entire creation process is stopped when a double-click event is encountered.
  • Constructor Details

    • TLspComplexPolygonEditor

      public TLspComplexPolygonEditor()
      Creates a new TLspComplexPolygonEditor. This constructor initializes a default TLsp2DPointListEditor to be used as a delegate when editing and creating polygons inside a complex polygon.
    • TLspComplexPolygonEditor

      public TLspComplexPolygonEditor(TLsp2DPointListEditor aCustomPointListEditorDelegate)
      Creates a new TLspComplexPolygonEditor. This constructor uses the given TLsp2DPointListEditor as a delegate when editing and creating polygons inside a complex polygon.
      aCustomPointListEditorDelegate - the delegate point list editor to be used for creating and editing polygons inside this pointlist.
  • Method Details

    • canEdit

      public boolean canEdit(TLspEditContext aContext)
      Returns true if super returns true and the given object is an instance of ILcdEditableComplexPolygon.
      Specified by:
      canEdit in interface ILspEditor
      canEdit in class ALspEditor
      aContext - provides context information to the editor
      true if the above conditions are met, false otherwise.
    • getCreateHandle

      public ALspEditHandle getCreateHandle(TLspEditContext aContext)
      Returns a handle that is used to create the given object. The returned handle is used by the controller to initialize the other of the object.

      Typically the returned handle is an instance of ALspCreateHandle which is a specialized handle implementation used for creating an object.

      By default, this method returns an ALspCreateHandle capable of creating an ILcdEditableComplexPolygon, as described in the class javadoc.

      aContext - provides context information such as the layer for which the object is being created
      an edit handle, or null if creation should not be allowed.
      See Also:
    • getEditHandles

      public List<ALspEditHandle> getEditHandles(TLspEditContext aContext)
      Returns a set of handles for editing the given object.

      These handles will be able to generate edit operations, that are passed to the edit method. As a way to communicate with this method, handles will copy their properties to the edit operation properties. By default this method delegates to the createObjectTranslationHandle method. It is added for convenience, so it can easily be overridden. Further, this method adds handles for every polygon in the complex polygon.

      aContext - provides context information such as the layer for which the object is being edited
      the edit handles to edit the given object, or an empty list if it should not be possible to edit the given object.
      See Also:
    • createObjectTranslationHandle

      protected ALspEditHandle createObjectTranslationHandle(ILcdComplexPolygon aComplexPolygon, TLspEditContext aContext)
      Creates an edit handle that allows the user to translate the given shape. By default this is a TLspObjectTranslationHandle.
      aComplexPolygon - the shape for which the handle is created
      aContext - the current context
      an edit handle or null if no handle is needed
    • editImpl

      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.

      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:

      The POLYGON_IDENTIFIER property is used to identify the sub polygon on which to apply the operation. If no polygon is specified, and the edit operation is a MOVE operation, the entire complex polygon is moved.

      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.

      Specified by:
      editImpl in class ALspEditor
      aOperation - the event that contains the information on how to edit the object
      aInteractionStatus -
      aContext - the edit context
      SUCCESS if the above conditions are met, FAILED otherwise. The invalidation hint will be set if a point was added or removed.
    • getCreationMode

      public ELspCreationMode getCreationMode()
      Returns how the delegate point list editor behaves during creation.
      the creation mode of the delegate point list editor
    • setCreationMode

      public void setCreationMode(ELspCreationMode aCreationMode)
      Returns how the delegate point list editor behaves during creation.
      aCreationMode - the creation mode to be set on the delegate point list editor