com.luciad.view.gxy.controller

LuciadLightspeedClass TLcdGXYEditControllerModel2

java.lang.Object

com.luciad.view.gxy.controller.TLcdGXYEditControllerModel2

All Implemented Interfaces:

ILcdUndoableSource

public class TLcdGXYEditControllerModel2
extends Object

This TLcdGXYEditControllerModel2 contains the input-independent logic for editing objects on an ILcdGXYView. It encapsulates what is edited, how it is edited, how the editing is visualized and how edits are applied. The most important concepts of this class are the following:

• editHowMode
• editWhatMode
• editingCandidates
• paintEditing
• applyEdit

The methods that correspond with the above concepts are typically invoked in that order, but the implementation must not depend on this exact order. The editHowMode is what the effect should be of the editing process: should the edited objects be translated, or reshaped? Please refer to the constants that start with EDIT_HOW for all possibilities. This is typically input-dependent and should be determined by the controller.

The editWhatMode defines what should be edited: the objects themselves, or their labels? Please refer to the constants that start with EDIT_WHAT for all possibilities.

The editingCandidates are those objects that are involved in the editing process. The method takes into account the modes to define the involved objects. If it is for example asked to return the editing candidates for a EDIT_WHAT_LABELS mode, it only returns objects that have labels next to them.

While the edit process is ongoing (e.g., the user is performing a drag), the objects are not edited all the time, they are just painted in their temporary state. The method paintEditing takes care of this. This method is typically invoked often (e.g., on mouse drag) while the edit process is ongoing.

Once the edit is complete, the method applyEdit performs the actual edit operation to the editing candidates. It delegates the real work to the ILcdGXYEditors or the ILcdGXYLabelEditors of the editing candidates, depending on the modes.

At all times - before an edit, during an edit or after an edit - the correct mouse cursor is provided by the method mouseCursor.

The edit operations, performed by applyEdit, can be undone, provided the ILcdGXYEditors and/or ILcdGXYLabelEditors to which the real work is delegated implement ILcdUndoableSource as well, to indicate that they support undo. Please refer to the developer guide for more information about undo.

The method snapTarget returns the target to snap the edited objects to. Please refer to the developer guide for an overview of snapping.

This edit controller model supports body label editing, see TLcdLabelLocation.isBodyLabel(). When a body label is translated (EDIT_HOW_TRANSLATING), its domain object is translated instead. When a body label is reshaped (EDIT_HOW_RESHAPING), it is translated instead. This is done by calling the ILcdGXYLabelEditor with the ILcdGXYLabelEditor.TRANSLATED mode instead of ILcdGXYLabelEditor.RESHAPED.

Subclasses can override these methods to alter their behavior. They can also introduce new modes, but care should be taken to override all methods, so that they all know how to handle this new mode (calling super with an existing mode could be useful). Integer constants used for those new modes should be greater than or equal to 1 << 25.

Note: editing labels is only supported if:

• The label painter implements ILcdGXYLabelPainter2 (not just ILcdGXYLabelPainter)
• The layer implements ILcdGXYEditableLabelsLayer
• An ILcdGXYLabelEditor is set to the layer.

Since:

7.0

See Also:

TLcdGXYMultiPointEditControllerModel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLcdGXYEditControllerModel2.SnapTargetInfo Object representing all needed information about a snap target.

Field Summary

Fields

Modifier and Type	Field and Description
static int	EDIT_HOW_NO_CHANGE Mode defining that no changes should be made.
static int	EDIT_HOW_RESHAPING Mode defining that editing should reshape the editing candidates.
static int	EDIT_HOW_TRANSLATING Mode defining that editing should translate the editing candidates.
static int	EDIT_WHAT_FIRST_TOUCHED_LABEL Mode defining that editing (e.g., translating or reshaping) should act on the first touched label only.
static int	EDIT_WHAT_LABELS Mode defining that editing (e.g., translating or reshaping) should act on the labels.
static int	EDIT_WHAT_NO_CHANGE Mode defining that no changes should be made.
static int	EDIT_WHAT_OBJECTS Mode defining that editing (e.g., translating or reshaping) should act on the objects (e.g., the points, polylines, ...).

Constructor Summary

Constructors

Constructor and Description
TLcdGXYEditControllerModel2() Default constructor

Method Summary

Modifier and Type	Method and Description
void	addUndoableListener(ILcdUndoableListener aListener) Adds a listener to this source, so this listener is notified when something undoable has happened.
boolean	applyEdit(ILcdGXYView aGXYView, ILcdGXYLayerSubsetList aSnappables, List<Point> aFrom, List<Point> aTo, int aEditHow, int aEditWhat, ILcdGXYLayerSubsetList aEditingCandidates) Applies the edit to every object of the given subset, by delegating the real work to ILcdGXYEditor.edit with the mode TRANSLATED (or RESHAPED if aEditHow is EDIT_HOW_RESHAPING).
boolean	applyEdit(ILcdGXYView aGXYView, ILcdGXYLayerSubsetList aSnappables, Point aFrom, Point aTo, MouseEvent aMouseEvent, int aEditHow, int aEditWhat, ILcdGXYLayerSubsetList aEditingCandidates) Applies the edit to every object of the given subset, by delegating the real work to ILcdGXYEditor.edit with the mode TRANSLATED (or RESHAPED if aEditHow is EDIT_HOW_RESHAPING).
protected TLcdCompositeUndoable	createCompositeUndoable() Deprecated. Override createTotalOperationUndoable(com.luciad.view.gxy.ILcdGXYView, java.awt.Point, java.awt.Point, java.awt.event.MouseEvent, int, int, com.luciad.view.gxy.ILcdGXYLayerSubsetList). That method provides more useful parameters.
protected TLcdCompositeUndoable	createSingleObjectUndoable(Object aDomainObject, ILcdGXYLayer aLayer, ILcdGXYView aGXYView, Point aFrom, Point aTo, MouseEvent aMouseEvent, int aEditHow, int aEditWhat, ILcdGXYLayerSubsetList aEditingCandidates) Creates the composite undoable that will wrap all the undoables generated by a single ILcdGXYEditor for a single domain object.
protected TLcdCompositeUndoable	createTotalOperationUndoable(ILcdGXYView aGXYView, Point aFrom, Point aTo, MouseEvent aMouseEvent, int aEditHow, int aEditWhat, ILcdGXYLayerSubsetList aEditingCandidates) Creates the composite undoable that will wrap all undoables generated by all the underlying editors for all the edited domain objects.
static String	editHowAsString(int aEditHow) Utility method that converts the given edit-how mode to a human readable string.
int	editHowMode(ILcdGXYView aGXYView, ILcdGXYLayerSubsetList aSnappables, Point aFrom, Point aTo, MouseEvent aMouseEvent) Deprecated. The controllers themselves should be responsible for specifying the edit how mode, mainly because it is very dependent on the kind of input device.
ILcdGXYLayerSubsetList	editingCandidates(ILcdGXYView aGXYView, ILcdGXYLayerSubsetList aSnappables, Point aFrom, Point aTo, MouseEvent aMouseEvent, int aEditHow, int aEditWhat) Returns the set of candidates for editing, respecting the given modes. For EDIT_HOW_TRANSLATING, the candidates are those objects that are selected, visible and editable on the given ILcdGXYView.
static String	editWhatAsString(int aEditWhat) Utility method that converts the given edit-what mode to a human readable string.
int	editWhatMode(ILcdGXYView aGXYView, ILcdGXYLayerSubsetList aSnappables, Point aFrom, Point aTo, MouseEvent aMouseEvent, int aEditHow) Deprecated. The controllers themselves should be responsible for any dependency on InputEvents of the edit-what mode
protected void	fireUndoableHappened(ILcdUndoable aUndoable) Notify all undoable listeners that aUndoable has happened.
int	getSensitivity() This method returns the sensitivity that will be used when editing objects or labels.
boolean	isTraceOn() Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
Cursor	mouseCursor(ILcdGXYView aGXYView, ILcdGXYLayerSubsetList aSnappables, Point aFrom, Point aTo, MouseEvent aMouseEvent, int aEditHow, int aEditWhat, ILcdGXYLayerSubsetList aEditingCandidates) Returns the desired cursor for the given parameters.
void	paintEditing(Graphics aGraphics, ILcdGXYView aGXYView, ILcdGXYLayerSubsetList aSnappables, Point aFrom, Point aTo, MouseEvent aMouseEvent, int aEditHow, int aEditWhat, ILcdGXYLayerSubsetList aEditingCandidates) Paints the given set of edit candidates in their temporary editing state.
void	removeUndoableListener(ILcdUndoableListener aListener) Removes the specified listener so it is no longer notified.
static void	setClassTraceOn(boolean aClassTraceOn) Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
void	setSensitivity(int aSensitivity) This method sets the sensitivity that should be used by painters/editors to determine which object (or part of the object) is edited by the input device (usually the mouse).
void	setStringTranslator(ILcdStringTranslator aStringTranslator) Sets the ILcdStringTranslator that this controller model should use to translate the Strings that will be visible in the user interface.
void	setTraceOn(boolean aTraceOn) Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
TLcdGXYEditControllerModel2.SnapTargetInfo	snapTarget(ILcdGXYView aGXYView, ILcdGXYLayerSubsetList aSnappables, Point aFrom, Point aTo, MouseEvent aMouseEvent, int aEditHow, int aEditWhat, Object aObjectToSnap, ILcdGXYLayer aObjectToSnapGXYLayer) Tries to retrieve a snap target from the given aSnappables.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EDIT_HOW_RESHAPING

public static final int EDIT_HOW_RESHAPING

Mode defining that editing should reshape the editing candidates. What exactly reshaping means is up to the implementations of ILcdGXYEditor and ILcdGXYLabelEditor.

EDIT_HOW_TRANSLATING

public static final int EDIT_HOW_TRANSLATING

Mode defining that editing should translate the editing candidates. What exactly translating means is up to the implementations of ILcdGXYEditor and ILcdGXYLabelEditor.

EDIT_HOW_NO_CHANGE

public static final int EDIT_HOW_NO_CHANGE

Mode defining that no changes should be made.

EDIT_WHAT_OBJECTS

public static final int EDIT_WHAT_OBJECTS

Mode defining that editing (e.g., translating or reshaping) should act on the objects (e.g., the points, polylines, ...).

EDIT_WHAT_LABELS

public static final int EDIT_WHAT_LABELS

Mode defining that editing (e.g., translating or reshaping) should act on the labels.

EDIT_WHAT_FIRST_TOUCHED_LABEL

public static final int EDIT_WHAT_FIRST_TOUCHED_LABEL

Mode defining that editing (e.g., translating or reshaping) should act on the first touched label only. This is especially useful when objects have multiple labels, that should be edited independently.

EDIT_WHAT_NO_CHANGE

public static final int EDIT_WHAT_NO_CHANGE

Mode defining that no changes should be made.

Constructor Detail

TLcdGXYEditControllerModel2

public TLcdGXYEditControllerModel2()

Default constructor

Method Detail

setClassTraceOn

public static void setClassTraceOn(boolean aClassTraceOn)

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Enables tracing for all instances of this class. If the argument is true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

Parameters:

aClassTraceOn - if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

setTraceOn

public void setTraceOn(boolean aTraceOn)

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Enables tracing for this class instance. Calling this method with either true or false as argument automatically turns off tracing for all other class instances for which setTraceOn has not been called. If the argument is false then only the informative, warning and error log messages are recorded.

Parameters:

aTraceOn - if true then all log messages are recorded for this instance. If false, then only the informative, warning and error log messages are recorded.

isTraceOn

public boolean isTraceOn()

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Returns true if tracing is enabled for this class.

Returns:

true if tracing is enabled for this class, false otherwise.

createCompositeUndoable

protected TLcdCompositeUndoable createCompositeUndoable()

Deprecated. Override createTotalOperationUndoable(com.luciad.view.gxy.ILcdGXYView, java.awt.Point, java.awt.Point, java.awt.event.MouseEvent, int, int, com.luciad.view.gxy.ILcdGXYLayerSubsetList). That method provides more useful parameters.

Creates the composite undoable that will wrap all undoables generated by the underlying editors. This default implementation returns a TLcdCompositeUndoable with the display name "Edit Objects", translated with the set ILcdStringTranslator.

Returns:

The composite undoable that will be fired when the edit operation is complete.

editHowMode

public int editHowMode(ILcdGXYView aGXYView,
                       ILcdGXYLayerSubsetList aSnappables,
                       Point aFrom,
                       Point aTo,
                       MouseEvent aMouseEvent)

Deprecated. The controllers themselves should be responsible for specifying the edit how mode, mainly because it is very dependent on the kind of input device.

Returns the edit-how mode. This mode indicates how the edit should behave: should the editing candidates be translated or reshaped?

It returns EDIT_HOW_RESHAPING if ctrl is pressed, EDIT_HOW_TRANSLATING if no modifiers are pressed, and EDIT_HOW_NO_CHANGE otherwise.

Please note that the actual meaning of reshaping and translating is defined by the implementation of ILcdGXYPainter/ILcdGXYEditor that is used.

Parameters:

aGXYView - The ILcdGXYView, provided as contextual information.

aSnappables - The list of potential snapping candidates, provided as contextual information.

aFrom - The point where the edit originated.

aTo - The point where the edit terminated (so far).

aMouseEvent - The last mouse event that was involved in the edit process.

Returns:

One of the constants in this class that start with EDIT_HOW.

See Also:

TLcdGXYEditController2.editHowMode(com.luciad.view.gxy.ILcdGXYView, com.luciad.view.gxy.ILcdGXYLayerSubsetList, java.awt.Point, java.awt.Point, java.awt.event.MouseEvent)

editWhatMode

public int editWhatMode(ILcdGXYView aGXYView,
                        ILcdGXYLayerSubsetList aSnappables,
                        Point aFrom,
                        Point aTo,
                        MouseEvent aMouseEvent,
                        int aEditHow)

Deprecated. The controllers themselves should be responsible for any dependency on InputEvents of the edit-what mode

Returns the edit-what mode. This mode indicates what the edit should do: should the labels be edited, or the objects themselves?

If the left mouse button is used, returns EDIT_WHAT_OBJECTS if the objects are touched for aFrom, and EDIT_WHAT_LABELS if the labels are touched for aFrom. If the mouse event is a mouse moved event, the test on the mouse button is skipped. So for that case, it returns what would happen if a button would be pressed. In all other cases, EDIT_WHAT_NO_CHANGE is returned.

Touched is defined as ILcdGXYPainter.isTouched(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext) or ILcdGXYLabelPainter2.isLabelTouched(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext).

Parameters:

aGXYView - The ILcdGXYView, provided as contextual information.

aSnappables - The list of potential snapping candidates, provided as contextual information.

aFrom - The point where the edit originated.

aTo - The point where the edit terminated (so far).

aMouseEvent - The last mouse event that was involved in the edit process.

aEditHow - The edit-how mode: one of the constants in this class that start with EDIT_HOW. For example the result of the method editHowMode.

Returns:

one of the constants in this class that start with EDIT_WHAT.

See Also:

TLcdGXYEditController2.editWhatMode(com.luciad.view.gxy.ILcdGXYView, com.luciad.view.gxy.ILcdGXYLayerSubsetList, java.awt.Point, java.awt.Point, java.awt.event.MouseEvent, int)

paintEditing

public void paintEditing(Graphics aGraphics,
                         ILcdGXYView aGXYView,
                         ILcdGXYLayerSubsetList aSnappables,
                         Point aFrom,
                         Point aTo,
                         MouseEvent aMouseEvent,
                         int aEditHow,
                         int aEditWhat,
                         ILcdGXYLayerSubsetList aEditingCandidates)

Paints the given set of edit candidates in their temporary editing state. The real painting work is delegated to ILcdGXYPainter.paint with the mode ILcdGXYPainter.TRANSLATING or ILcdGXYPainter.RESHAPING, depending on aEditHow. Similarly for labels, the work is delegated to ILcdGXYLabelPainter2.paintLabel with the mode ILcdGXYLabelPainter2.TRANSLATING or ILcdGXYLabelPainter2.RESHAPING.

When either the aEditHow is EDIT_HOW_NO_CHANGE or aEditWhat is EDIT_WHAT_NO_CHANGE, this method will do nothing.

Parameters:

aGraphics - The graphics to draw on.

aGXYView - The ILcdGXYView, provided as contextual information.

aSnappables - The list of potential snapping candidates, provided as contextual information.

aFrom - The point where the edit originated.

aTo - The point where the edit terminated (so far).

aMouseEvent - The last mouse event that was involved in the edit process. You can pass null if another input device is used.

aEditHow - The edit-how mode: one of the constants in this class that start with EDIT_HOW. For example the result of the method editHowMode.

aEditWhat - The edit-what mode: one of the constants in this class that start with EDIT_WHAT. For example the result of the method editWhatMode.

aEditingCandidates - The objects (and their corresponding layers) that are being edited.

editingCandidates

public ILcdGXYLayerSubsetList editingCandidates(ILcdGXYView aGXYView,
                                                ILcdGXYLayerSubsetList aSnappables,
                                                Point aFrom,
                                                Point aTo,
                                                MouseEvent aMouseEvent,
                                                int aEditHow,
                                                int aEditWhat)

Returns the set of candidates for editing, respecting the given modes.

For EDIT_HOW_TRANSLATING, the candidates are those objects that are selected, visible and editable on the given ILcdGXYView. If, for these candidates, an object handle is touched, only the object to which the touched handle belongs is returned, otherwise all candidates are returned.

For EDIT_HOW_RESHAPING and EDIT_WHAT_FIRST_TOUCHED_LABEL, it returns the first selected object that is visible, editable and touched.

Touched is defined as ILcdGXYPainter.isTouched(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext) or ILcdGXYLabelPainter2.isLabelTouched(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext), depending on aEditWhat.

Parameters:

aGXYView - The ILcdGXYView, provided as contextual information.

aSnappables - The list of potential snapping candidates, provided as contextual information.

aFrom - The point where the edit originated.

aTo - The point where the edit terminated (so far).

aMouseEvent - The last mouse event that was involved in the edit process. You can pass null if another input device is used.

aEditHow - The edit-how mode: one of the constants in this class that start with EDIT_HOW. For example the result of the method editHowMode.

aEditWhat - The edit-what mode: one of the constants in this class that start with EDIT_WHAT. For example the result of the method editWhatMode.

Returns:

This list of editing candidates. This list can be empty, but never null.

applyEdit

public boolean applyEdit(ILcdGXYView aGXYView,
                         ILcdGXYLayerSubsetList aSnappables,
                         Point aFrom,
                         Point aTo,
                         MouseEvent aMouseEvent,
                         int aEditHow,
                         int aEditWhat,
                         ILcdGXYLayerSubsetList aEditingCandidates)

Applies the edit to every object of the given subset, by delegating the real work to ILcdGXYEditor.edit with the mode TRANSLATED (or RESHAPED if aEditHow is EDIT_HOW_RESHAPING). Note that the actual meaning of reshaping and translating is defined by the implementation of ILcdGXYPainter/ILcdGXYEditor that is used.

Similarly editing labels is delegated to ILcdGXYLabelEditor.editLabel with the mode ILcdGXYLabelEditor.TRANSLATED or ILcdGXYLabelEditor.RESHAPED.

This method has no effect if aEditHow is EDIT_HOW_NO_CHANGE or if aEditWhat is EDIT_WHAT_NO_CHANGE.

After all objects/labels are edited, the needed model changed events and label location changed events are fired.

After the edit is completed, an TLcdUndoableEvent is fired to the registered listeners if any undo information was provided by the ILcdGXYEditors or ILcdGXYLabelEditors to which the real work is delegated. They can do so by implementing the ILcdUndoableSource interface and by firing an TLcdUndoableEvent when their edit or editLabel method is invoked. The undoable event this class sends out to its listeners is a composite undoable composed of all the events send out by the ILcdGXYEditors or ILcdGXYLabelEditors.

Parameters:

aGXYView - The ILcdGXYView, provided as contextual information.

aSnappables - The list of potential snapping candidates.

aFrom - The point where the edit originated.

aTo - The point where the edit terminated.

aMouseEvent - The last mouse event that was involved in the edit process.

aEditHow - The edit-how mode: one of the constants in this class that start with EDIT_HOW. For example the result of the method editHowMode.

aEditWhat - The edit-what mode: one of the constants in this class that start with EDIT_WHAT. For example the result of the method editWhatMode.

aEditingCandidates - The objects (and their corresponding layers) that need to be edited.

Returns:

True if at least one object/label was modified, false otherwise.

createTotalOperationUndoable

protected TLcdCompositeUndoable createTotalOperationUndoable(ILcdGXYView aGXYView,
                                                             Point aFrom,
                                                             Point aTo,
                                                             MouseEvent aMouseEvent,
                                                             int aEditHow,
                                                             int aEditWhat,
                                                             ILcdGXYLayerSubsetList aEditingCandidates)

Creates the composite undoable that will wrap all undoables generated by all the underlying editors for all the edited domain objects. This method is called from the applyEdit method. This default implementation returns a TLcdCompositeUndoable with the display name "Edit Objects". Override this method if you want another name.

Parameters:

aGXYView - The view for which the edit operation is being performed for which the undoable is created.

aFrom - The point where the edit originated.

aTo - The point where the edit terminated.

aMouseEvent - The last mouse event that was involved in the edit process. You can pass null if another input device is used.

aEditHow - The edit-how mode: one of the constants in this class that start with EDIT_HOW. For example the result of the method editHowMode.

aEditWhat - The edit-what mode: one of the constants in this class that start with EDIT_WHAT. For example the result of the method editWhatMode.

aEditingCandidates - The objects (and their corresponding layers) that need to be edited.

Returns:

The composite undoable that will be fired when the edit operation is complete. Must not be null.

createSingleObjectUndoable

protected TLcdCompositeUndoable createSingleObjectUndoable(Object aDomainObject,
                                                           ILcdGXYLayer aLayer,
                                                           ILcdGXYView aGXYView,
                                                           Point aFrom,
                                                           Point aTo,
                                                           MouseEvent aMouseEvent,
                                                           int aEditHow,
                                                           int aEditWhat,
                                                           ILcdGXYLayerSubsetList aEditingCandidates)

Creates the composite undoable that will wrap all the undoables generated by a single ILcdGXYEditor for a single domain object. This method is called from the applyEdit method. The default implementation returns a TLcdCompositeUndoable with the display name "Edit " + String.valueOf(aDomainObject).

Parameters:

aDomainObject - The domain object from the model which is being edited.

aLayer - The layer of the domain object which is being edited.

aGXYView - The view for which the edit operation is being performed for which the undoable is created.

aFrom - The point where the edit originated.

aTo - The point where the edit terminated.

aMouseEvent - The last mouse event that was involved in the edit process. You can pass null if another input device is used.

aEditHow - The edit-how mode: one of the constants in this class that start with EDIT_HOW. For example the result of the method editHowMode.

aEditWhat - The edit-what mode: one of the constants in this class that start with EDIT_WHAT. For example the result of the method editWhatMode.

aEditingCandidates - The objects (and their corresponding layers) that need to be edited.

Returns:

The composite undoable that will be fired when the edit operation is complete. Must not be null.

snapTarget

public TLcdGXYEditControllerModel2.SnapTargetInfo snapTarget(ILcdGXYView aGXYView,
                                                             ILcdGXYLayerSubsetList aSnappables,
                                                             Point aFrom,
                                                             Point aTo,
                                                             MouseEvent aMouseEvent,
                                                             int aEditHow,
                                                             int aEditWhat,
                                                             Object aObjectToSnap,
                                                             ILcdGXYLayer aObjectToSnapGXYLayer)

Tries to retrieve a snap target from the given aSnappables. It does so by invoking snapTarget (or labelSnapTarget, depending on aEditWhat) on the ILcdGXYPainters (or ILcdGXYLabelPainter2s) of the objects in aSnappables. If the snap target returned by one of those painters is accepted by the ILcdGXYEditor of aObjectToSnap, it is returned.

When no snap target can be found this method returns null.

Parameters:

aGXYView - The ILcdGXYView, provided as contextual information.

aSnappables - The list of potential snapping candidates.

aFrom - The point where the edit originated.

aTo - The point where the edit terminated (so far).

aMouseEvent - The last mouse event that was involved in the edit process. You can pass null if another input device is used.

aEditHow - The edit-how mode: one of the constants in this class that start with EDIT_HOW. For example the result of the method editHowMode.

aEditWhat - The edit-what mode: one of the constants in this class that start with EDIT_WHAT. For example the result of the method editWhatMode.

aObjectToSnap - the object that would like to snap to one of the candidates in aSnappables, so basically the object that is being edited.

aObjectToSnapGXYLayer - the layer whose model contains aObjectToSnap.

Returns:

The snap info, or null if no snap target was found.

mouseCursor

public Cursor mouseCursor(ILcdGXYView aGXYView,
                          ILcdGXYLayerSubsetList aSnappables,
                          Point aFrom,
                          Point aTo,
                          MouseEvent aMouseEvent,
                          int aEditHow,
                          int aEditWhat,
                          ILcdGXYLayerSubsetList aEditingCandidates)

Returns the desired cursor for the given parameters. The mouse cursor is retrieved from the ILcdGXYPainter/ILcdGXYLabelPainter2 of the touched object using getCursor or getLabelCursor, depending on aEditWhat. As a result, the cursor can be null if no specific cursor is needed.

Touched is defined as ILcdGXYPainter.isTouched(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext) or ILcdGXYLabelPainter2.isLabelTouched(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext).

Parameters:

aGXYView - The ILcdGXYView, provided as contextual information.

aSnappables - The list of potential snapping candidates, provided as contextual information.

aFrom - The point where the edit originated.

aTo - The point where the edit terminated (so far).

aMouseEvent - The last mouse event that was involved in the edit process.

aEditHow - The edit-how mode: one of the constants in this class that start with EDIT_HOW. For example the result of the method editHowMode.

aEditWhat - The edit-what mode: one of the constants in this class that start with EDIT_WHAT. For example the result of the method editWhatMode.

aEditingCandidates - The objects (and their corresponding layers) that are being edited.

Returns:

The desired cursor for the given parameters, or null if no specific cursor is needed.

editHowAsString

public static String editHowAsString(int aEditHow)

Utility method that converts the given edit-how mode to a human readable string. This method is intended for debugging or logging purposes.

Parameters:

aEditHow - The edit how mode, one of the constants in this class that start with EDIT_HOW.

Returns:

A human readable string representation for the given edit-how mode.

editWhatAsString

public static String editWhatAsString(int aEditWhat)

Utility method that converts the given edit-what mode to a human readable string. This method is intended for debugging or logging purposes.

Parameters:

aEditWhat - The edit what mode, one of the constants in this class that start with EDIT_WHAT.

Returns:

A human readable string representation for the given edit-what mode.

setStringTranslator

public void setStringTranslator(ILcdStringTranslator aStringTranslator)

Sets the ILcdStringTranslator that this controller model should use to translate the Strings that will be visible in the user interface.

This method should be called before this editor is used. Any Strings already created by this controller model will not be translated with the specified translator.

The following list of Strings are translated by the given instance:

• "Edit Objects"
• "Edit {0}". The translated String is used as the pattern for a MessageFormat.
• "Model was unreferenced due to memory constraints."
• "Domain object was unreferenced due to memory constraints."

Parameters:

aStringTranslator - The ILcdStringTranslator that should be used. Must not be null.

addUndoableListener

public void addUndoableListener(ILcdUndoableListener aListener)

Description copied from interface: ILcdUndoableSource

Adds a listener to this source, so this listener is notified when something undoable has happened.

Specified by:

addUndoableListener in interface ILcdUndoableSource

Parameters:

aListener - The listener to be notified when something undoable has happened.

removeUndoableListener

public void removeUndoableListener(ILcdUndoableListener aListener)

Description copied from interface: ILcdUndoableSource

Removes the specified listener so it is no longer notified.

Specified by:

removeUndoableListener in interface ILcdUndoableSource

Parameters:

aListener - The listener to remove.

fireUndoableHappened

protected void fireUndoableHappened(ILcdUndoable aUndoable)

Notify all undoable listeners that aUndoable has happened.

Parameters:

aUndoable - The undoable of which the listeners should be notified.

applyEdit

public boolean applyEdit(ILcdGXYView aGXYView,
                         ILcdGXYLayerSubsetList aSnappables,
                         List<Point> aFrom,
                         List<Point> aTo,
                         int aEditHow,
                         int aEditWhat,
                         ILcdGXYLayerSubsetList aEditingCandidates)

Applies the edit to every object of the given subset, by delegating the real work to ILcdGXYEditor.edit with the mode TRANSLATED (or RESHAPED if aEditHow is EDIT_HOW_RESHAPING). All input points are passed to the edit method. Note that the actual meaning of reshaping and translating is defined by the implementation of ILcdGXYPainter/ILcdGXYEditor that is used.

Similarly editing labels is delegated to ILcdGXYLabelEditor.editLabel with the mode ILcdGXYLabelEditor.TRANSLATED or ILcdGXYLabelEditor.RESHAPED.

This method will do nothing if aEditHow is EDIT_HOW_NO_CHANGE or if aEditWhat is EDIT_WHAT_NO_CHANGE, and just return false.

After all objects/labels are edited, the needed model changed events and label location changed events are fired.

After the edit is completed, an TLcdUndoableEvent is fired to the registered listeners if any undo information was provided by the ILcdGXYEditors or ILcdGXYLabelEditors to which the real work is delegated. They can do so by implementing the ILcdUndoableSource interface and by firing an TLcdUndoableEvent when their edit or editLabel method is invoked. The undoable event this class sends out to its listeners is a composite undoable composed of all the events send out by the ILcdGXYEditors or ILcdGXYLabelEditors.

Parameters:

aGXYView - The ILcdGXYView, provided as contextual information.

aSnappables - The list of potential snapping candidates.

aFrom - A list with point(s) where the edit originated. Should have the same length as aTo, and the order of the points in both lists should be the same, e.g. the location of the first point of aFrom when the edit terminated should be passed as the first point in aTo.

aTo - A list with point(s) where the edit terminated (so far). Should have the same length as aFrom, and the order of the points in both list should be the same, e.g. the location of the first point of aFrom when the edit terminated should be passed as the first point in aTo.

aEditHow - The edit-how mode: one of the constants in this class that start with EDIT_HOW.

aEditWhat - The edit-what mode: one of the constants in this class that start with EDIT_WHAT. For example the result of the method editWhatMode.

aEditingCandidates - The objects (and their corresponding layers) that need to be edited.

Returns:

True if at least one object/label was modified, false otherwise.

getSensitivity

public int getSensitivity()

This method returns the sensitivity that will be used when editing objects or labels. It indicates how far (in screen coordinates) the input location (mouse cursor, etc...) can be from the visual representation of an object or handle on the screen and still interact with it. This value will be passed to all created instances of TLcdGXYContext passed to the painters/editors.

Returns:

the sensitivity to be used for painting/editing purposes.

See Also:

setSensitivity(int), TLcdGXYContext.getSensitivity()

setSensitivity

public void setSensitivity(int aSensitivity)

This method sets the sensitivity that should be used by painters/editors to determine which object (or part of the object) is edited by the input device (usually the mouse).

Parameters:

aSensitivity - the sensitivity that will be used for painting/editing purposes.

See Also:

getSensitivity(), TLcdGXYSelectControllerModel2.setSensitivity(int)