Class TLspTextEditor

All Implemented Interfaces:

public class TLspTextEditor extends ALspEditor
Enables visual editing of ILcd2DEditableText objects in an ILspView.


The text editor defines the following edit handles for a text object:
  • Object translation handle: allows the user to translate the text. This handle generates MOVE operations, with a xy constraint, 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 text. 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:
  • Object translation handle
    Translating a text object.


This editor initializes the text's location. If the user wants to change the text properties of the text objects during the creation process, then he/she should either create an extension of this editor or apply the properties to the object before it is passed to this editor (i.e. before getCreateHandle() is called). The latter can be achieved by implementing a custom ALspCreateControllerModel.
  • Constructor Details

    • TLspTextEditor

      public TLspTextEditor()
      Creates a new TLspTextEditor. This constructor does not initialize any state.
  • Method Details

    • canEdit

      public boolean canEdit(TLspEditContext aContext)
      Returns true if super returns true and the given object is an instance of ILcd2DEditableText.
      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.
    • 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:

      Specified by:
      editImpl in class ALspEditor
      aOperation - the event that contains the information on how to edit the object
      aInteractionStatus - the interaction status
      aContext - the edit context
      The result of the operation: Whether or not there was success, and whether or not the current handles of the object should be invalidated.
    • 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. This method returns either a list with a single handle, or an empty list.

      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(ILcd2DEditableText aText, TLspEditContext aContext)
      Creates an edit handle that allows the user to translate the given shape. By default this is a TLspObjectTranslationHandle.
      aText - the shape for which the handle is created
      aContext - the current context
      an edit handle or null if no handle is needed
    • 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 ILcd2DEditableText, 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: