Package com.luciad.edit

Class EditSettings

java.lang.Object
com.luciad.edit.EditSettings
All Implemented Interfaces:
AutoCloseable
public final class EditSettings extends Object implements AutoCloseable
This class contains settings that can be used as defaults for IFeatureHandlesProvider and IGeometryHandlesProvider implementations.

To change the defaults, you can create a new instance of this class, adapt the settings, and configure it on the Editor class.

These settings are typically used in the following way:

If you need to customize edit behavior that is not available in this class, you can do so by creation and customizing the handles directly. The following handle implementations can for example be used and customized:

Most handles providers allow you to specify which handles are used. See for example:

  • Constructor Details

    • EditSettings

      public EditSettings()
      Creates a new EditSettings instance with default values.

  • Method Details

    • finalize

      protected void finalize()
      Overrides:
      finalize in class Object

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable

    • getHandleIconRegular

      @Nullable public IIcon getHandleIconRegular()
      Returns the icon for inactive handles.
      Returns:
      the icon for inactive handles.

    • setHandleIconRegular

      public void setHandleIconRegular(@Nullable IIcon icon)
      Sets the icon for inactive handles.

      Can be null. In that case no icon is painted.

      Parameters:
      icon - the icon for inactive handles.

    • getHandleIconHighlighted

      @Nullable public IIcon getHandleIconHighlighted()
      Returns the icon for highlighted handles.
      Returns:
      the icon for highlighted handles.

    • setHandleIconHighlighted

      public void setHandleIconHighlighted(@Nullable IIcon icon)
      Sets the icon for highlighted handles.

      Can be null. In that case no icon is painted.

      Parameters:
      icon - the icon for highlighted handles.

    • getHandleIconActive

      @Nullable public IIcon getHandleIconActive()
      Returns the icon for active handles.
      Returns:
      the icon for active handles.

    • setHandleIconActive

      public void setHandleIconActive(@Nullable IIcon icon)
      Sets the icon for active handles.

      Can be null. In that case no icon is painted.

      Parameters:
      icon - the icon for active handles.

    • getAuxiliaryHandleIconRegular

      @Nullable public IIcon getAuxiliaryHandleIconRegular()
      Returns the auxiliary icon for inactive handles.
      Returns:
      the auxiliary icon for inactive handles.

    • setAuxiliaryHandleIconRegular

      public void setAuxiliaryHandleIconRegular(@Nullable IIcon icon)
      Sets the auxiliary icon for inactive handles.

      Can be null. In that case no icon is painted.

      Parameters:
      icon - the auxiliary icon for inactive handles.

    • getAuxiliaryHandleIconHighlighted

      @Nullable public IIcon getAuxiliaryHandleIconHighlighted()
      Returns the auxiliary icon for highlighted handles.
      Returns:
      the auxiliary icon for highlighted handles.

    • setAuxiliaryHandleIconHighlighted

      public void setAuxiliaryHandleIconHighlighted(@Nullable IIcon icon)
      Sets the auxiliary icon for highlighted handles.

      Can be null. In that case no icon is painted.

      Parameters:
      icon - the auxiliary icon for highlighted.

    • getAuxiliaryHandleIconActive

      @Nullable public IIcon getAuxiliaryHandleIconActive()
      Returns the auxiliary icon for active handles.
      Returns:
      the auxiliary icon for active handles.

    • setAuxiliaryHandleIconActive

      public void setAuxiliaryHandleIconActive(@Nullable IIcon icon)
      Sets the auxiliary icon for active handles.

      Can be null. In that case no icon is painted.

      Parameters:
      icon - the auxiliary icon for active handles.

    • getOutlineStyleRegular

      @Nullable public LineStyle getOutlineStyleRegular()
      Returns the line style that is used for inactive handles that paint an outline.

      This method is linked to the getComplexStrokeOutlineStyleRegular method:

      • if both of them return null, no outline is painted
      • if one of them is not null, that line style is used
      • it's not possible for both methods to return a non null value: they are mutually exclusive
      Returns:
      the line style that is used for inactive handles that paint an outline.

    • setOutlineStyleRegular

      public void setOutlineStyleRegular(@Nullable LineStyle style)
      Sets the line style that is used for inactive handles that paint an outline.

      Only one regular line style can be set, if this function is called with a non null value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

      Parameters:
      style - the line style that is used for handles that manipulate an outline in a EditHandleState#Inactive state.

    • getComplexStrokeOutlineStyleRegular

      @Nullable public ComplexStrokeLineStyle getComplexStrokeOutlineStyleRegular()
      Returns the complex stroke line style that is used for inactive handles that paint an outline.

      This method is linked to the getOutlineStyleRegular method:

      • if both of them return null, no outline is painted
      • if one of them is not null, that line style is used
      • it's not possible for both methods to return a non null value: they are mutually exclusive
      Returns:
      the complex stroke line style that is used for inactive handles that paint an outline.
      Since:
      2023.1

    • setComplexStrokeOutlineStyleRegular

      public void setComplexStrokeOutlineStyleRegular(@Nullable ComplexStrokeLineStyle style)
      Sets the complex stroke line style that is used for inactive handles that paint an outline.

      Only one active line style can be set, if this function is called with a non null value when a LineStyle has already been set, it will be overwritten.

      Parameters:
      style - the complex stroke line style that is used for inactive handles that paint an outline.
      Since:
      2023.1

    • getOutlineStyleHighlighted

      @Nullable public LineStyle getOutlineStyleHighlighted()
      Returns the line style that is used for highlighted handles that paint an outline.

      This method is linked to the getComplexStrokeOutlineStyleHighlighted method:

      • if both of them return null, no outline is painted
      • if one of them is not null, that line style is used
      • it's not possible for both methods to return a non null value: they are mutually exclusive
      Returns:
      the line style that is used for highlighted handles that paint an outline.

    • setOutlineStyleHighlighted

      public void setOutlineStyleHighlighted(@Nullable LineStyle style)
      Sets the line style that is used for highlighted handles that paint an outline.

      Only one highlighted line style can be set, if this function is called with a non null value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

      Parameters:
      style - the line style that is used for highlighted handles that paint an outline.

    • getComplexStrokeOutlineStyleHighlighted

      @Nullable public ComplexStrokeLineStyle getComplexStrokeOutlineStyleHighlighted()
      Returns the complex stroke line style that is used for highlighted handles that paint an outline.

      This method is linked to the getOutlineStyleHighlighted method:

      • if both of them return null, no outline is painted
      • if one of them is not null, that line style is used
      • it's not possible for both methods to return a non null value: they are mutually exclusive
      Returns:
      the complex stroke line style that is used for highlighted handles that paint an outline.
      Since:
      2023.1

    • setComplexStrokeOutlineStyleHighlighted

      public void setComplexStrokeOutlineStyleHighlighted(@Nullable ComplexStrokeLineStyle style)
      Sets the complex stroke line style that is used for highlighted handles that paint an outline.

      Only one active line style can be set, if this function is called with a non null value when a LineStyle has already been set, it will be overwritten.

      Parameters:
      style - the complex stroke line style that is used for highlighted handles that paint an outline.
      Since:
      2023.1

    • getOutlineStyleActive

      @Nullable public LineStyle getOutlineStyleActive()
      Returns the line style that is used for active handles that paint an outline.

      This method is linked to the getComplexStrokeOutlineStyleActive method:

      • if both of them return null, no outline is painted
      • if one of them is not null, that line style is used
      • it's not possible for both methods to return a non null value: they are mutually exclusive
      Returns:
      the line style that is used for active handles that paint an outline.

    • setOutlineStyleActive

      public void setOutlineStyleActive(@Nullable LineStyle style)
      Sets the line style that is used for active handles that paint an outline.

      Only one active line style can be set, if this function is called with a non null value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

      Parameters:
      style - the line style that is used for active handles that paint an outline.

    • getComplexStrokeOutlineStyleActive

      @Nullable public ComplexStrokeLineStyle getComplexStrokeOutlineStyleActive()
      Returns the complex stroke line style that is used for active handles that paint an outline.

      This method is linked to the getOutlineStyleActive method:

      • if both of them return null, no outline is painted
      • if one of them is not null, that line style is used
      • it's not possible for both methods to return a non null value: they are mutually exclusive
      Returns:
      the complex stroke line style that is used for active handles that paint an outline.
      Since:
      2023.1

    • setComplexStrokeOutlineStyleActive

      public void setComplexStrokeOutlineStyleActive(@Nullable ComplexStrokeLineStyle style)
      Sets the complex stroke line style that is used for active handles that paint an outline.

      Only one active line style can be set, if this function is called with a non null value when a LineStyle has already been set, it will be overwritten.

      Parameters:
      style - the complex stroke line style that is used for active handles that paint an outline.
      Since:
      2023.1

    • getVisualAidLineStyle

      @Nullable public LineStyle getVisualAidLineStyle()
      Returns the line style that is used for visual aid lines.

      This method is linked to the getVisualAidComplexStrokeLineStyle method:

      • if both of them return null, no visual aid line is painted
      • if one of them is not null, that visual aid line style is used
      • it's not possible for both methods to return a non null value: they are mutually exclusive
      Returns:
      the line style that is used for visual aid lines.

    • setVisualAidLineStyle

      public void setVisualAidLineStyle(@Nullable LineStyle style)
      Sets the line style that is used for visual aid lines.

      Only one visual aid line style can be set, if this function is called with a non null value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

      Parameters:
      style - the line style that is used for visual aid lines.

    • getVisualAidComplexStrokeLineStyle

      @Nullable public ComplexStrokeLineStyle getVisualAidComplexStrokeLineStyle()
      Returns the complex stroke line style that is used for visual aid lines.

      This method is linked to the getVisualAidLineStyle method:

      • if both of them return null, no visual aid line is painted
      • if one of them is not null, that visual aid line style is used
      • it's not possible for both methods to return a non null value: they are mutually exclusive
      Returns:
      the complex stroke line style that is used for visual aid lines.
      Since:
      2023.1

    • setVisualAidComplexStrokeLineStyle

      public void setVisualAidComplexStrokeLineStyle(@Nullable ComplexStrokeLineStyle style)
      Sets the complex stroke line style that is used for visual aid lines.

      Only one visual aid line style can be set, if this function is called with a non null value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

      Parameters:
      style - the complex stroke line style that is used for visual aid lines.
      Since:
      2023.1

    • getShadowIcon

      @Nullable public IIcon getShadowIcon()
      Returns the icon that is used when a shadow version of a geometry is painted.
      Returns:
      the icon that is used when a shadow version of a geometry is painted.

    • setShadowIcon

      public void setShadowIcon(@Nullable IIcon icon)
      Sets the icon that is used when a shadow version of a geometry is painted.

      Can be null. In that case no icon is painted.

      Parameters:
      icon - the icon that is used when a shadow version of a geometry is painted.

    • getShadowLineStyle

      @Nullable public LineStyle getShadowLineStyle()
      Returns the line style that is used for shadow lines.

      This method is linked to the getShadowComplexStrokeLineStyle method:

      • if both of them return null, no shadow line is painted
      • if one of them is not null, that shadow line style is used
      • it's not possible for both methods to return a non null value: they are mutually exclusive
      Returns:
      the line style that is used for shadow lines.

    • setShadowLineStyle

      public void setShadowLineStyle(@Nullable LineStyle style)
      Sets the line style that is used for shadow lines.

      Only one shadow line style can be set, if this function is called with a non null value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

      Parameters:
      style - the line style that is used for shadow lines.

    • getShadowComplexStrokeLineStyle

      @Nullable public ComplexStrokeLineStyle getShadowComplexStrokeLineStyle()
      Returns the complex stroke line style that is used for shadow lines.

      This method is linked to the getShadowLineStyle method:

      • if both of them return null, no shadow line is painted
      • if one of them is not null, that shadow line style is used
      • it's not possible for both methods to return a non null value: they are mutually exclusive
      Returns:
      the complex stroke line style that is used for shadow lines.
      Since:
      2023.1

    • setShadowComplexStrokeLineStyle

      public void setShadowComplexStrokeLineStyle(@Nullable ComplexStrokeLineStyle style)
      Sets the complex stroke line style that is used for shadow lines.

      Only one shadow line style can be set, if this function is called with a non null value when a ComplexStrokeLineStyle has already been set, it will be overwritten.

      Parameters:
      style - the complex stroke line style that is used for shadow lines.
      Since:
      2023.1

    • getShadowFillStyle

      @Nullable public FillStyle getShadowFillStyle()
      Returns the fill style that is used when a shadow version of a geometry is painted.
      Returns:
      the fill style that is used when a shadow version of a geometry is painted.

    • setShadowFillStyle

      public void setShadowFillStyle(@Nullable FillStyle style)
      Sets the fill style that is used when a shadow version of a geometry is painted.

      Setting this to null means the shadow version of the geometry won't have a fill style.

      Parameters:
      style - fill style that is used when a shadow version of a geometry is painted.

    • getTranslateCursor

      @NotNull public MouseCursor getTranslateCursor()
      Returns the cursor that is used for translate handles.
      Returns:
      the cursor that is used for translate handles.

    • setTranslateCursor

      public void setTranslateCursor(@NotNull MouseCursor cursor)
      Sets the cursor that is used for translate handles.
      Parameters:
      cursor - the cursor that is used for translate handles

    • getMoveCursor

      @NotNull public MouseCursor getMoveCursor()
      Returns the cursor that is used for handles that move something.
      Returns:
      the cursor that is used for handles that move something.

    • setMoveCursor

      public void setMoveCursor(@NotNull MouseCursor cursor)
      Sets the cursor that is used for handles that move something.
      Parameters:
      cursor - the cursor that is used for handles that move something

    • getRemoveCursor

      @NotNull public MouseCursor getRemoveCursor()
      Returns the cursor that is used for handles that remove something.
      Returns:
      the cursor that is used for handles that remove something.

    • setRemoveCursor

      public void setRemoveCursor(@NotNull MouseCursor cursor)
      Sets the cursor that is used for handles that remove something.
      Parameters:
      cursor - the cursor that is used for handles that remove something

    • getInsertCursor

      @NotNull public MouseCursor getInsertCursor()
      Returns the cursor that is used for handles that insert something.
      Returns:
      the cursor that is used for handles that insert something.

    • setInsertCursor

      public void setInsertCursor(@NotNull MouseCursor cursor)
      Sets the cursor that is used for handles that insert something.
      Parameters:
      cursor - the cursor that is used for handles that insert something

    • getPrependAppendCursor

      @NotNull public MouseCursor getPrependAppendCursor()
      Returns the cursor that is used for handles that prepend or append something.
      Returns:
      the cursor that is used for handles that prepend or append something.

    • setPrependAppendCursor

      public void setPrependAppendCursor(@NotNull MouseCursor cursor)
      Sets the cursor that is used for handles that prepend or append something.
      Parameters:
      cursor - the cursor that is used for handles that prepend or append something

    • getElevationCursor

      @NotNull public MouseCursor getElevationCursor()
      Returns the cursor that is used for handles that manipulate elevation.
      Returns:
      the cursor that is used for handles that manipulate elevation.

    • setElevationCursor

      public void setElevationCursor(@NotNull MouseCursor cursor)
      Sets the cursor that is used for handles that manipulate elevation.
      Parameters:
      cursor - the cursor that is used for handles that manipulate elevation

    • getTranslateButton

      @NotNull public MouseButton getTranslateButton()
      Returns the mouse button that is used for translate handles.
      Returns:
      the mouse button that is used for translate handles.

    • setTranslateButton

      public void setTranslateButton(@NotNull MouseButton button)
      Sets the mouse button that is used for translate handles.
      Parameters:
      button - the mouse button that is used for translate handles

    • getMoveButton

      @NotNull public MouseButton getMoveButton()
      Returns the mouse button that is used by handles to move something.
      Returns:
      the mouse button that is used by handles to move something.

    • setMoveButton

      public void setMoveButton(@NotNull MouseButton button)
      Sets the mouse button that is used by handles to move something.
      Parameters:
      button - the mouse button that is used by handles to move something

    • getRemoveButton

      @NotNull public MouseButton getRemoveButton()
      Returns the mouse button that is used by handles to remove something.
      Returns:
      the mouse button that is used by handles to remove something.

    • setRemoveButton

      public void setRemoveButton(@NotNull MouseButton button)
      Sets the mouse button that is used by handles to remove something.
      Parameters:
      button - the mouse button that is used by handles to remove something

    • getInsertButton

      @NotNull public MouseButton getInsertButton()
      Returns the mouse button that is used by handles to insert something.
      Returns:
      the mouse button that is used by handles to insert something.

    • setInsertButton

      public void setInsertButton(@NotNull MouseButton button)
      Sets the mouse button that is used by handles to insert something.
      Parameters:
      button - the mouse button that is used by handles to insert something

    • getPrependAppendButton

      @NotNull public MouseButton getPrependAppendButton()
      Returns the mouse button that is used by handles that prepend or append something.
      Returns:
      the mouse button that is used by handles that prepend or append something.

    • setPrependAppendButton

      public void setPrependAppendButton(@NotNull MouseButton button)
      Sets the mouse button that is used by handles that prepend or append something.
      Parameters:
      button - the mouse button that is used by handles that prepend or append something

    • getElevationButton

      @NotNull public MouseButton getElevationButton()
      Returns the mouse button that is used by handles to modify elevation.
      Returns:
      the mouse button that is used by handles to modify elevation.

    • setElevationButton

      public void setElevationButton(@NotNull MouseButton button)
      Sets the mouse button that is used by handles to modify elevation.
      Parameters:
      button - the mouse button that is used by handles to modify elevation

    • getTranslateModifierKeys

      @NotNull public ModifierKeys getTranslateModifierKeys()
      Returns the modifier keys that are used by the translate handles.
      Returns:
      the modifier keys that are used by the translate handles.

    • setTranslateModifierKeys

      public void setTranslateModifierKeys(@NotNull ModifierKeys modifierKeys)
      Sets the modifier keys that are used by the translate handles.
      Parameters:
      modifierKeys - the modifier keys that are used by the translate handles

    • getMoveModifierKeys

      @NotNull public ModifierKeys getMoveModifierKeys()
      Returns the modifier keys that are used by handles to move something.
      Returns:
      the modifier keys that are used by handles to move something.

    • setMoveModifierKeys

      public void setMoveModifierKeys(@NotNull ModifierKeys modifierKeys)
      Sets the modifier keys that are used by handles to move something.
      Parameters:
      modifierKeys - the modifier keys that are used by handles to move something

    • getRemoveModifierKeys

      @NotNull public ModifierKeys getRemoveModifierKeys()
      Returns the modifier keys that are used by handles to remove something.
      Returns:
      the modifier keys that are used by handles to remove something.

    • setRemoveModifierKeys

      public void setRemoveModifierKeys(@NotNull ModifierKeys modifierKeys)
      Sets the modifier keys that are used by handles to remove something.
      Parameters:
      modifierKeys - the modifier keys that are used by handles to remove something

    • getInsertModifierKeys

      @NotNull public ModifierKeys getInsertModifierKeys()
      Returns the modifier keys that are used by handles to insert something.
      Returns:
      the modifier keys that are used by handles to insert something.

    • setInsertModifierKeys

      public void setInsertModifierKeys(@NotNull ModifierKeys modifierKeys)
      Sets the modifier keys that are used by handles to insert something.
      Parameters:
      modifierKeys - the modifier keys that are used by handles to insert something

    • getPrependAppendModifierKeys

      @NotNull public ModifierKeys getPrependAppendModifierKeys()
      Returns the modifier keys that are used by handles to prepend or append something.
      Returns:
      the modifier keys that are used by handles to prepend or append something.

    • setPrependAppendModifierKeys

      public void setPrependAppendModifierKeys(@NotNull ModifierKeys modifierKeys)
      Sets the modifier keys that are used by handles to prepend or append something.
      Parameters:
      modifierKeys - the modifier keys that are used by handles to prepend or append something

    • getElevationModifierKeys

      @NotNull public ModifierKeys getElevationModifierKeys()
      Returns the modifier keys that are used by handles to modify elevation.
      Returns:
      the modifier keys that are used by handles to modify elevation.

    • setElevationModifierKeys

      public void setElevationModifierKeys(@NotNull ModifierKeys modifierKeys)
      Sets the modifier keys that are used by handles to modify elevation.
      Parameters:
      modifierKeys - the modifier keys that are used by handles to modify elevation