com.yworks.yfiles.view.input

Class LabelTextValidatingEventArgs

java.lang.Object

com.yworks.yfiles.view.input.InputModeEventArgs

com.yworks.yfiles.view.input.LabelTextValidatingEventArgs

All Implemented Interfaces:

IEventArgs

public final class LabelTextValidatingEventArgs
extends InputModeEventArgs

Event arguments for the ValidateLabelText event.

Event handlers can set the Canceling property to true to cancel label editing if validation failed, or set the NewText property to a changed, validated value.

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
LabelTextValidatingEventArgs(IInputModeContext context, ILabel label, String newText) Initializes a new instance of the LabelTextValidatingEventArgs class.

Method Summary

Modifier and Type	Method and Description
ILabel	getLabel() Gets the label that is being edited.
String	getNewText() Gets the new text to use for the label.
boolean	isCanceling() Gets a value indicating whether the edit should be canceled.
void	setCanceling(boolean value) Sets a value indicating whether the edit should be canceled.
void	setNewText(String value) Sets the new text to use for the label.

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

LabelTextValidatingEventArgs

public LabelTextValidatingEventArgs(IInputModeContext context,
                                    ILabel label,
                                    String newText)

Initializes a new instance of the LabelTextValidatingEventArgs class.

Parameters:

context - The context.

label - The label.

newText - The initial new text as entered by the user.

Method Detail

getLabel

public final ILabel getLabel()

Gets the label that is being edited.

Note that the label might not belong to a graph if it is a dummy for a label that is about to be created.

Returns:

The Label.

getNewText

public final String getNewText()

Gets the new text to use for the label.

Returns:

The new text.

See Also:

isCanceling(), setNewText(String)

isCanceling

public final boolean isCanceling()

Gets a value indicating whether the edit should be canceled.

Returns:

true if the new text is not valid and should not be used for the edit; false otherwise.

See Also:

setCanceling(boolean)

setCanceling

public final void setCanceling(boolean value)

Sets a value indicating whether the edit should be canceled.

Parameters:

value - true if the new text is not valid and should not be used for the edit; false otherwise.

See Also:

isCanceling()

setNewText

public final void setNewText(String value)

Sets the new text to use for the label.

Parameters:

value - The new text.

See Also:

isCanceling(), getNewText()