com.yworks.yfiles.view.input

Class LabelEditingEventArgs

java.lang.Object

com.yworks.yfiles.view.input.InputModeEventArgs

com.yworks.yfiles.view.input.LabelEditingEventArgs

All Implemented Interfaces:

IEventArgs

public final class LabelEditingEventArgs
extends InputModeEventArgs

Event arguments for the LabelAdding and LabelEditing events, as well as the IEditLabelHelper interface.

Field Summary

Fields inherited from interface com.yworks.yfiles.utils.IEventArgs

EMPTY

Constructor Summary

Constructors

Constructor and Description
LabelEditingEventArgs(IInputModeContext context, ILabelOwner owner, ILabel label) Initializes a new instance of the LabelEditingEventArgs class with the given context, owner, and label.

Method Summary

Modifier and Type	Method and Description
ILabel	getLabel() Gets the label to edit.
ILabelModelParameter	getLayoutParameter() Gets the LayoutParameter of the label to add.
ILabelOwner	getOwner() Gets the owner of the label.
SizeD	getPreferredSize() Gets the PreferredSize of the label to add.
ILabelStyle	getStyle() Gets the Style of the label to add.
Object	getTag() Gets the Tag of the label to add.
ITextEditorInputModeConfigurationHandler	getTextEditorInputModeConfigurator() Configures the TextEditorInputMode for editing the provided label instance.
boolean	isCancel() Gets a value indicating whether the action (adding or editing a label) should be canceled.
boolean	isHandled() Gets a value indicating whether this event has been handled.
void	setCancel(boolean value) Sets a value indicating whether the action (adding or editing a label) should be canceled.
void	setHandled(boolean value) Sets a value indicating whether this event has been handled.
void	setLabel(ILabel value) Sets the label to edit.
void	setLayoutParameter(ILabelModelParameter value) Sets the LayoutParameter of the label to add.
void	setOwner(ILabelOwner value) Sets the owner of the label.
void	setPreferredSize(SizeD value) Sets the PreferredSize of the label to add.
void	setStyle(ILabelStyle value) Sets the Style of the label to add.
void	setTag(Object value) Sets the Tag of the label to add.
void	setTextEditorInputModeConfigurator(ITextEditorInputModeConfigurationHandler value) Configures the TextEditorInputMode for editing the provided label instance.

Methods inherited from class com.yworks.yfiles.view.input.InputModeEventArgs

getContext

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelEditingEventArgs

public LabelEditingEventArgs(IInputModeContext context,
                             ILabelOwner owner,
                             ILabel label)

Initializes a new instance of the LabelEditingEventArgs class with the given context, owner, and label.

Parameters:

context - The input mode context to use.

owner - The ILabelOwner whose label should be edited.

label - The ILabel that should be edited.

Method Detail

getLabel

public final ILabel getLabel()

Gets the label to edit.

This can be set to an exiting label to edit a specific one, or set to null to add a new label instead (e.g. for ILabelOwners that have no label yet).

If this property is set to null, the properties Style, PreferredSize, LayoutParameter, and Tag are used for the newly-added label, just like with LabelEditingEventArgs.

Setting this property implicitly also sets Handled to true.

Returns:

The Label.

See Also:

setLabel(ILabel)

getLayoutParameter

public final ILabelModelParameter getLayoutParameter()

Gets the LayoutParameter of the label to add.

Setting this property implicitly also sets Handled to true.

Returns:

The LayoutParameter.

See Also:

setLayoutParameter(ILabelModelParameter)

getOwner

public final ILabelOwner getOwner()

Gets the owner of the label.

This property can be null if there is no owner known, e.g. if the event is raised for non-ILabelOwners. Otherwise it is initially set to the item for which the event is raised.

Setting this property implicitly also sets Handled to true.

Returns:

The Owner.

See Also:

setOwner(ILabelOwner)

getPreferredSize

public final SizeD getPreferredSize()

Gets the PreferredSize of the label to add.

Setting this property implicitly also sets Handled to true.

Returns:

The PreferredSize.

See Also:

setPreferredSize(SizeD)

getStyle

public final ILabelStyle getStyle()

Gets the Style of the label to add.

Setting this property implicitly also sets Handled to true.

Returns:

The Style.

See Also:

setStyle(ILabelStyle)

getTag

public final Object getTag()

Gets the Tag of the label to add.

Setting this property implicitly also sets Handled to true.

Returns:

The Tag.

See Also:

setTag(Object)

getTextEditorInputModeConfigurator

public final ITextEditorInputModeConfigurationHandler getTextEditorInputModeConfigurator()

Configures the TextEditorInputMode for editing the provided label instance.

Setting this property implicitly also sets Handled to true.

Returns:

The TextEditorInputModeConfigurator.

See Also:

setTextEditorInputModeConfigurator(ITextEditorInputModeConfigurationHandler)

isCancel

public final boolean isCancel()

Gets a value indicating whether the action (adding or editing a label) should be canceled.

Setting this property implicitly also sets Handled to true.

Returns:

The Cancel.

See Also:

setCancel(boolean)

isHandled

public final boolean isHandled()

Gets a value indicating whether this event has been handled.

A handled instance of LabelEditingEventArgs will not be passed to further event handlers or an IEditLabelHelper instance.

Setting any of the other properties implicitly also sets this to true.

Returns:

The Handled.

See Also:

setHandled(boolean)

setCancel

public final void setCancel(boolean value)

Sets a value indicating whether the action (adding or editing a label) should be canceled.

Setting this property implicitly also sets Handled to true.

Parameters:

value - The Cancel to set.

See Also:

isCancel()

setHandled

public final void setHandled(boolean value)

Sets a value indicating whether this event has been handled.

A handled instance of LabelEditingEventArgs will not be passed to further event handlers or an IEditLabelHelper instance.

Setting any of the other properties implicitly also sets this to true.

Parameters:

value - The Handled to set.

See Also:

isHandled()

setLabel

public final void setLabel(ILabel value)

Sets the label to edit.

This can be set to an exiting label to edit a specific one, or set to null to add a new label instead (e.g. for ILabelOwners that have no label yet).

If this property is set to null, the properties Style, PreferredSize, LayoutParameter, and Tag are used for the newly-added label, just like with LabelEditingEventArgs.

Setting this property implicitly also sets Handled to true.

Parameters:

value - The Label to set.

See Also:

getLabel()

setLayoutParameter

public final void setLayoutParameter(ILabelModelParameter value)

Sets the LayoutParameter of the label to add.

Setting this property implicitly also sets Handled to true.

Parameters:

value - The LayoutParameter to set.

See Also:

getLayoutParameter()

setOwner

public final void setOwner(ILabelOwner value)

Sets the owner of the label.

This property can be null if there is no owner known, e.g. if the event is raised for non-ILabelOwners. Otherwise it is initially set to the item for which the event is raised.

Setting this property implicitly also sets Handled to true.

Parameters:

value - The Owner to set.

See Also:

getOwner()

setPreferredSize

public final void setPreferredSize(SizeD value)

Sets the PreferredSize of the label to add.

Setting this property implicitly also sets Handled to true.

Parameters:

value - The PreferredSize to set.

See Also:

getPreferredSize()

setStyle

public final void setStyle(ILabelStyle value)

Sets the Style of the label to add.

Setting this property implicitly also sets Handled to true.

Parameters:

value - The Style to set.

See Also:

getStyle()

setTag

public final void setTag(Object value)

Sets the Tag of the label to add.

Setting this property implicitly also sets Handled to true.

Parameters:

value - The Tag to set.

See Also:

getTag()

setTextEditorInputModeConfigurator

public final void setTextEditorInputModeConfigurator(ITextEditorInputModeConfigurationHandler value)

Configures the TextEditorInputMode for editing the provided label instance.

Setting this property implicitly also sets Handled to true.

Parameters:

value - The TextEditorInputModeConfigurator to set.

See Also:

getTextEditorInputModeConfigurator()