com.yworks.yfiles.view.input

Interface ILabelSnapContextHelper

All Known Implementing Classes:

LabelSnapContextHelper

public interface ILabelSnapContextHelper

Provides the snap lines and the snap results to the LabelSnapContext during dragging of labels.

See Also:

LabelSnapContext, LabelDecorator.getLabelSnapContextHelperDecorator()

Method Summary

Modifier and Type	Method and Description
void	addSnapLines(LabelSnapContext snapContext, IInputModeContext inputModeContext, ILabel label) Called during initialization of a label dragging to add snap lines to which the label can potentially snap to the snapContext.
void	collectSnapResults(LabelSnapContext context, CollectSnapResultsEventArgs args, IOrientedRectangle suggestedLayout, ILabel label) Called while the given label is dragged to add snap results for the snap lines provided by the context.

Method Detail

addSnapLines

void addSnapLines(LabelSnapContext snapContext,
                  IInputModeContext inputModeContext,
                  ILabel label)

Called during initialization of a label dragging to add snap lines to which the label can potentially snap to the snapContext.

Parameters:

snapContext - The snap context which manages the snap lines and the settings. Note that implementations should not change the state of the context explicitly.

inputModeContext - The context of the input mode that handles the dragging.

label - The label that is dragged.

collectSnapResults

void collectSnapResults(LabelSnapContext context,
                        CollectSnapResultsEventArgs args,
                        IOrientedRectangle suggestedLayout,
                        ILabel label)

Called while the given label is dragged to add snap results for the snap lines provided by the context.

Parameters:

context - The snap context which manages the snap lines and the settings.

args - The event argument to obtain the necessary information from and add results to.

suggestedLayout - The layout of the label that would be used without snapping.

label - The label that is dragged.