com.yworks.yfiles.view.input

Class EditLabelHelper

java.lang.Object

com.yworks.yfiles.view.input.EditLabelHelper

All Implemented Interfaces:

IEditLabelHelper

public class EditLabelHelper
extends Object
implements IEditLabelHelper

Simple default implementation of the IEditLabelHelper interface.

This class provided a number of factory methods that can be overwritten to change the default behavior which is modeled after the behavior used by GraphEditorInputMode's GraphEditorInputMode.createLabel(ILabelOwner) and GraphEditorInputMode.editLabel(ILabel).

Constructor Summary

Constructors

Constructor and Description
EditLabelHelper()

Method Summary

Modifier and Type	Method and Description
IGraph	getGraph() Gets the graph instance to retrieve the default values from.
protected ILabelModelParameter	getLabelParameter(IInputModeContext context, ILabelOwner owner) Determines the label model parameter to use for the label, depending on the owner.
protected ILabelStyle	getLabelStyle(IInputModeContext context, ILabelOwner owner) Determines the style to use for the label, depending on the owner.
protected SizeD	getPreferredSize(IInputModeContext context, ILabel label) Gets the preferred size for the label.
void	onLabelAdding(LabelEditingEventArgs args) Helper method that will be called for ILabelOwners.
void	onLabelEditing(LabelEditingEventArgs args) Helper method that will be called for ILabelOwners.
void	setGraph(IGraph value) Sets the graph instance to retrieve the default values from.

Methods inherited from class java.lang.Object

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

Constructor Detail

EditLabelHelper

public EditLabelHelper()

Method Detail

getGraph

public final IGraph getGraph()

Gets the graph instance to retrieve the default values from.

If this instance is not set, the implementation will try to retrieve the graph from the IInputModeContext's ILookup.

Returns:

The graph instance.

See Also:

setGraph(IGraph)

getLabelParameter

protected ILabelModelParameter getLabelParameter(IInputModeContext context,
                                                 ILabelOwner owner)

Determines the label model parameter to use for the label, depending on the owner.

This method will obtain the default parameter instances from the Graph considering the type of the current owner.

Parameters:

context - The input mode context.

owner - The label's owner.

Returns:

The layout parameter to use or null.

getLabelStyle

protected ILabelStyle getLabelStyle(IInputModeContext context,
                                    ILabelOwner owner)

Determines the style to use for the label, depending on the owner.

This method will obtain the default style instances from the Graph considering the type of the current owner.

Parameters:

context - The input mode context.

owner - The label's owner.

Returns:

The style to use or null.

getPreferredSize

protected SizeD getPreferredSize(IInputModeContext context,
                                 ILabel label)

Gets the preferred size for the label.

This implementation yields null to indicate that the preferred size should be calculated after the text has been entered.

Parameters:

context - The input mode context.

label - The label to get the preferred size from.

Returns:

The size to use or null.

onLabelAdding

public void onLabelAdding(LabelEditingEventArgs args)

Helper method that will be called for ILabelOwners.

This method delegates to getLabelParameter(IInputModeContext, ILabelOwner), getLabelStyle(IInputModeContext, ILabelOwner), and getPreferredSize(IInputModeContext, ILabel) to set the appropriate properties on args and sets the Handled property to true. Label creation thus is always possible.

Specified by:

onLabelAdding in interface IEditLabelHelper

Parameters:

args - The original event arguments.

See Also:

IEditLabelHelper.onLabelEditing(LabelEditingEventArgs)

onLabelEditing

public void onLabelEditing(LabelEditingEventArgs args)

Helper method that will be called for ILabelOwners.

This method returns the first of the Labels that belong to the Owner, if set. Otherwise, it delegates to getLabelParameter(IInputModeContext, ILabelOwner), getLabelStyle(IInputModeContext, ILabelOwner), and getPreferredSize(IInputModeContext, ILabel) to set the appropriate properties on args.

The arguments are always set as Handled, so label editing is always possible.

Specified by:

onLabelEditing in interface IEditLabelHelper

Parameters:

args - The original event arguments.

See Also:

IEditLabelHelper.onLabelAdding(LabelEditingEventArgs)

setGraph

public final void setGraph(IGraph value)

Sets the graph instance to retrieve the default values from.

If this instance is not set, the implementation will try to retrieve the graph from the IInputModeContext's ILookup.

Parameters:

value - The graph instance.

See Also:

getGraph()