TextEditorInputMode (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.view.input.TextEditorInputMode

All Implemented Interfaces:

IInputMode
```
public class TextEditorInputMode
extends Object
implements IInputMode
```
A simple IInputMode that displays a TextArea instance in the CanvasControl to let the user edit a text.
Hitting escape or enter will cancel or stop editing.

This mode is Exclusive by default.

Property Summary

All Methods Instance Methods Concrete Methods
Type Property and Description

StringProperty editorText
Gets the current text property of the text input editor.

All Methods Instance Methods Concrete Methods
Type	Property and Description
`StringProperty`	`editorText` Gets the current text property of the text input editor.

Constructor Summary

Constructors
Constructor and Description
`TextEditorInputMode()` Creates a new instance using a default text box.
`TextEditorInputMode(TextArea textBox)` Creates a new instance using the given text box instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEditingCanceledListener(IEventHandler<TextEventArgs> editingCanceledEvent)` Adds the given listener for the `EditingCanceled` event that occurs if the editing has not been finished.
`void`	`addEditingStartedListener(IEventHandler<TextEventArgs> editingStartedEvent)` Adds the given listener for the `EditingStarted` event that occurs when text editing is started.
`void`	`addTextEditedListener(IEventHandler<TextEventArgs> textEditedEvent)` Adds the given listener for the `TextEdited` event that occurs once the text has been edited.
`protected void`	`adjustPosition()` Adjusts the position of the text box in the `CanvasControl`.
`void`	`cancel()` Cancels editing of the text box.
`void`	`clear()` Resets the contents of the text box.
`protected TextInputControl`	`createTextBox()` Factory method that creates a default text box.
`StringProperty`	`editorTextProperty()` Gets the current text property of the text input editor.
`protected void`	`ensureVisible()` Adjusts the `Viewport` of the `CanvasControl` so the TextBox is in the visible area.
`IPoint`	`getAnchor()` Gets the anchor of the text box.
`IEventRecognizer`	`getCancelRecognizer()` Gets the `IEventRecognizer` to detect when editing the text shall be canceled.
`protected ConcurrencyController`	`getController()` Returns the installed `Controller`.
`String`	`getEditorText()` Gets the current text of the text input editor.
`IInputModeContext`	`getInputModeContext()` Returns the context instance this mode is currently installed in or `null` if this instance is not installed.
`IEventRecognizer`	`getLineBreakRecognizer()` Gets the `IEventRecognizer` to detect the key gesture for new line breaks.
`IPoint`	`getLocation()` Gets the location of the text box in world coordinates.
`protected double`	`getMaximumZoom(SizeD textBoxSize)` Determines the text box's maximum zoom value.
`protected double`	`getMinimumZoom(SizeD textBoxSize)` Determines the text box's minimum zoom value.
`int`	`getPriority()` The priority of this input mode.
`IEventRecognizer`	`getStopRecognizer()` Gets the `IEventRecognizer` to detect when editing the text shall be stopped.
`TextInputControl`	`getTextBox()` Gets the text box to use for displaying and editing.
`protected RectD`	`getTextBoxBounds()` Returns the bounds of the TextBox.
`IPoint`	`getUpVector()` Gets the point that describes the "up"-vector that will be used to determine the orientation of the text box in the world coordinate system.
`void`	`install(IInputModeContext context, ConcurrencyController controller)` Installs this mode into the given context that is provided by the canvas.
`protected void`	`installTextBox()` Installs the text box in the canvas and puts focus into it.
`boolean`	`isAutoCommittingOnFocusLostEnabled()` Gets a property that determines whether the text edited should be committed if the focus gets lost or the editing should be canceled.
`boolean`	`isAutoFlippingTextBoxEnabled()` Gets a value indicating whether to automatically flip the orientation of the text box if the `UpVector` actually points downwards.
`boolean`	`isAutoFocusingCanvasOnEditorClosedEnabled()` Gets a property that determines whether this mode should try to `Node.requestFocus()` the `Canvas` once the editor is closed via a keyboard gesture.
`boolean`	`isAutoStartEditingEnabled()` Determines whether this mode should automatically fire up the editor once it gets installed.
`boolean`	`isEditing()` Gets the current editing state of the editor.
`boolean`	`isEnabled()` Gets the enabled state of this input mode.
`boolean`	`isExclusive()` Gets a value indicating whether this mode will be the only one running when it has the mutex.
`protected void`	`onBeginEditing()` Called when editing starts.
`protected void`	`onCanceled()` Called after `cancel()` has been called.
`protected void`	`onCancelEditing()` Called when editing gets canceled.
`protected void`	`onConcurrencyControllerActivated()` Called after the `Active` property of the installed `ConcurrencyController` has been set to `true`.
`protected void`	`onConcurrencyControllerDeactivated()` Called after the `Active` property of the installed `ConcurrencyController` has been set to `false`.
`protected void`	`onEditingCanceled(TextEventArgs args)` Raises the `EditingCanceled` event.
`protected void`	`onEditingStarted(TextEventArgs args)` Raises the `EditingStarted` event.
`protected void`	`onStopEditing()` Called when editing is stopped.
`protected void`	`onStopped()` Called after `stop()` has been called.
`protected void`	`onTextEdited(TextEventArgs args)` Raises the `TextEdited` event.
`void`	`removeEditingCanceledListener(IEventHandler<TextEventArgs> editingCanceledEvent)` Removes the given listener for the `EditingCanceled` event that occurs if the editing has not been finished.
`void`	`removeEditingStartedListener(IEventHandler<TextEventArgs> editingStartedEvent)` Removes the given listener for the `EditingStarted` event that occurs when text editing is started.
`void`	`removeTextEditedListener(IEventHandler<TextEventArgs> textEditedEvent)` Removes the given listener for the `TextEdited` event that occurs once the text has been edited.
`void`	`setAnchor(IPoint value)` Sets the anchor of the text box.
`void`	`setAutoCommittingOnFocusLostEnabled(boolean value)` Sets a property that determines whether the text edited should be committed if the focus gets lost or the editing should be canceled.
`void`	`setAutoFlippingTextBoxEnabled(boolean value)` Sets a value indicating whether to automatically flip the orientation of the text box if the `UpVector` actually points downwards.
`void`	`setAutoFocusingCanvasOnEditorClosedEnabled(boolean value)` Sets a property that determines whether this mode should try to `Node.requestFocus()` the `Canvas` once the editor is closed via a keyboard gesture.
`void`	`setAutoStartEditingEnabled(boolean value)` Determines whether this mode should automatically fire up the editor once it gets installed.
`void`	`setCancelRecognizer(IEventRecognizer value)` Sets the `IEventRecognizer` to detect when editing the text shall be canceled.
`void`	`setEditing(boolean value)` Sets the current editing state of the editor.
`void`	`setEditorText(String text)` Sets the current text of the text input editor.
`void`	`setEnabled(boolean value)` Sets the enabled state of this input mode.
`void`	`setExclusive(boolean value)` Sets a value indicating whether this mode will be the only one running when it has the mutex.
`void`	`setLineBreakRecognizer(IEventRecognizer value)` Sets the `IEventRecognizer` to detect the key gesture for new line breaks.
`void`	`setLocation(IPoint value)` Sets the location of the text box in world coordinates.
`void`	`setPriority(int value)` The priority of this input mode.
`void`	`setStopRecognizer(IEventRecognizer value)` Sets the `IEventRecognizer` to detect when editing the text shall be stopped.
`void`	`setTextBox(TextInputControl value)` Sets the text box to use for displaying and editing.
`void`	`setUpVector(IPoint value)` Sets the point that describes the "up"-vector that will be used to determine the orientation of the text box in the world coordinate system.
`protected boolean`	`showInViewCoordinates(SizeD textBoxSize)` Determines whether the text box should be displayed in the view coordinate system instead of in the world coordinate system.
`boolean`	`stop()` Stops editing and returns `true`.
`void`	`uninstall(IInputModeContext context)` Uninstalls this mode from the given context.
`protected void`	`uninstallTextBox()` Called to remove the text box from the application.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - editorText
```
public StringProperty editorTextProperty
```
    Gets the current text property of the text input editor.
    
    Returns:
    
    text property of the text input editor.
- Constructor Detail
  - TextEditorInputMode
```
public TextEditorInputMode()
```
    Creates a new instance using a default text box.
  - TextEditorInputMode
```
public TextEditorInputMode(TextArea textBox)
```
    Creates a new instance using the given text box instance.
    
    Parameters:
    
    textBox - The text box to use.
- Method Detail
  - addEditingCanceledListener
```
public final void addEditingCanceledListener(IEventHandler<TextEventArgs> editingCanceledEvent)
```
    Adds the given listener for the EditingCanceled event that occurs if the editing has not been finished.
    
    Parameters:
    
    editingCanceledEvent - The listener to add.
    
    See Also:
    
    removeEditingCanceledListener(IEventHandler)
  - addEditingStartedListener
```
public final void addEditingStartedListener(IEventHandler<TextEventArgs> editingStartedEvent)
```
    Adds the given listener for the EditingStarted event that occurs when text editing is started.
    
    Parameters:
    
    editingStartedEvent - The listener to add.
    
    See Also:
    
    removeEditingStartedListener(IEventHandler)
  - addTextEditedListener
```
public final void addTextEditedListener(IEventHandler<TextEventArgs> textEditedEvent)
```
    Adds the given listener for the TextEdited event that occurs once the text has been edited.
    
    Parameters:
    
    textEditedEvent - The listener to add.
    
    See Also:
    
    removeTextEditedListener(IEventHandler)
  - adjustPosition
```
protected void adjustPosition()
```
    Adjusts the position of the text box in the CanvasControl.
  - cancel
```
public void cancel()
```
    Cancels editing of the text box.
    
    Specified by:
    
    cancel in interface IInputMode
  - clear
```
public void clear()
```
    Resets the contents of the text box.
  - createTextBox
```
protected TextInputControl createTextBox()
```
    Factory method that creates a default text box.
    
    Returns:
    
    A text box implementation.
  - editorTextProperty
```
public StringProperty editorTextProperty()
```
    Gets the current text property of the text input editor.
    
    Returns:
    
    text property of the text input editor.
  - ensureVisible
```
protected void ensureVisible()
```
    Adjusts the Viewport of the CanvasControl so the TextBox is in the visible area.
    Called once when the editing starts.
  - getAnchor
```
public final IPoint getAnchor()
```
    Gets the anchor of the text box.
    The anchor is the point inside the coordinate system of the text box that shall coincide with the Location in the world coordinate system. The X and Y values are expressed as relative width/height ratios.
    
    Returns:
    
    The Anchor.
    
    See Also:
    
    setAnchor(IPoint)
  - getCancelRecognizer
```
public final IEventRecognizer getCancelRecognizer()
```
    Gets the IEventRecognizer to detect when editing the text shall be canceled.
    When the provided KeyEventArgs are recognized, cancel() is called.
    
    Returns:
    
    The cancel recognizer. The default recognizer checks for KeyCode.ESCAPE.
    
    See Also:
    
    getLineBreakRecognizer(), getStopRecognizer(), setCancelRecognizer(IEventRecognizer)
  - getController
```
protected final ConcurrencyController getController()
```
    Returns the installed Controller.
    
    Returns:
    
    The Controller.
  - getEditorText
```
public String getEditorText()
```
    Gets the current text of the text input editor.
    
    Returns:
    
    text of the text input editor.
  - getInputModeContext
```
public final IInputModeContext getInputModeContext()
```
    Description copied from interface: IInputMode
    
    Returns the context instance this mode is currently installed in or null if this instance is not installed.
    Note that this instance should not be passed down to subordinate modes or instances. Instead a corresponding context that has this instance set as the ParentInputMode should be used.
    
    Specified by:
    
    getInputModeContext in interface IInputMode
    
    Returns:
    
    The InputModeContext.
  - getLineBreakRecognizer
```
public final IEventRecognizer getLineBreakRecognizer()
```
    Gets the IEventRecognizer to detect the key gesture for new line breaks.
    When the provided KeyEventArgs are recognized, a new line break is inserted at the current curret position.
    
    Returns:
    
    The line break recognizer. The default recognizer checks for KeyCode.ENTER while ModifierKeys.SHORTCUT is pressed.
    
    See Also:
    
    getCancelRecognizer(), getStopRecognizer(), setLineBreakRecognizer(IEventRecognizer)
  - getLocation
```
public final IPoint getLocation()
```
    Gets the location of the text box in world coordinates.
    
    Returns:
    
    The Location.
    
    See Also:
    
    setLocation(IPoint)
  - getMaximumZoom
```
protected double getMaximumZoom(SizeD textBoxSize)
```
    Determines the text box's maximum zoom value. If the canvas zoom value is greater than this threshold, the text box keeps the size for this maximum value and does not grow further.
    By default, the text box zoom is limited to a value smaller than 3 or a dynamic threshold if the size of the text box would otherwise occupy a significant amount of space in the editor. Override and return Double.MAX_VALUE to effectively switch off the maximum zoom threshold.
    
    Parameters:
    
    textBoxSize - The size of the text box to display.
    
    Returns:
    
    The maximum zoom factor the text box should be scaled to.
  - getMinimumZoom
```
protected double getMinimumZoom(SizeD textBoxSize)
```
    Determines the text box's minimum zoom value. If the canvas zoom value is lesser than this threshold, the text box keeps the size for this minimum value and does not shrink any further.
    By default, the text box zoom is limited to a value greater than 0.1 or a font size greater than 8 if the zoom is taken into account. Override and return Double.NEGATIVE_INFINITY to effectively switch off this minimum zoom threshold.
    
    Parameters:
    
    textBoxSize - The size of the text box to display.
    
    Returns:
    
    The minimum zoom factor the text box should be scaled to.
  - getPriority
```
public final int getPriority()
```
    Description copied from interface: IInputMode
    
    The priority of this input mode.
    The priority will influence the order in which the modes will be installed into the canvas control. The lower the priority value, the earlier it will be installed. If two modes are installed using the same priority value, the first one will be installed earlier.
    
    Specified by:
    
    getPriority in interface IInputMode
    
    Returns:
    
    The Priority.
  - getStopRecognizer
```
public final IEventRecognizer getStopRecognizer()
```
    Gets the IEventRecognizer to detect when editing the text shall be stopped.
    When the provided KeyEventArgs are recognized, stop() is called.
    
    Returns:
    
    The stop recognizer. The default recognizer checks for KeyCode.ENTER while ModifierKeys.SHORTCUT is not pressed.
    
    See Also:
    
    getLineBreakRecognizer(), getCancelRecognizer(), setStopRecognizer(IEventRecognizer)
  - getTextBox
```
public final TextInputControl getTextBox()
```
    Gets the text box to use for displaying and editing. This will trigger the com.yworks.yfiles.input.TextEditorInputMode#createTextBox() factory method to create the instance to use during one editing. The same instance is then used for future text editing until #setTextBox(javafx.scene.control.Control) is called with a different instance.
    
    Returns:
    
    The TextBox.
    
    See Also:
    
    #setTextBox(javafx.scene.control.Control)
  - getTextBoxBounds
```
protected RectD getTextBoxBounds()
```
    Returns the bounds of the TextBox.
  - getUpVector
```
public final IPoint getUpVector()
```
    Gets the point that describes the "up"-vector that will be used to determine the orientation of the text box in the world coordinate system.
    The default is 0, -1.
    
    Returns:
    
    The UpVector.
    
    See Also:
    
    setUpVector(IPoint)
  - install
```
public void install(IInputModeContext context,
                    ConcurrencyController controller)
```
    Installs this mode into the given context that is provided by the canvas.
    In general a mode can only be installed into a single canvas at all times.
    
    This method is called to initialize this instance. Subclasses should override this method to register the corresponding event handler delegates for the various input events they need to register with.
    
    Overriding implementations should call the base implementation, first.
    
    Specified by:
    
    install in interface IInputMode
    
    Parameters:
    
    context - The context that this instance shall be installed into. The same instance will be passed to this instance during IInputMode.uninstall(IInputModeContext). A reference to the context may be kept and queried during the time the mode is installed.
    
    controller - The Controller for this mode.
    
    See Also:
    
    IInputMode.uninstall(IInputModeContext)
  - installTextBox
```
protected void installTextBox()
```
    Installs the text box in the canvas and puts focus into it.
  - isAutoCommittingOnFocusLostEnabled
```
public final boolean isAutoCommittingOnFocusLostEnabled()
```
    Gets a property that determines whether the text edited should be committed if the focus gets lost or the editing should be canceled.
    The default behavior is to cancel the editing process.
    
    Returns:
    
    The AutoCommittingOnFocusLostEnabled.
    
    See Also:
    
    setAutoCommittingOnFocusLostEnabled(boolean)
  - isAutoFlippingTextBoxEnabled
```
public final boolean isAutoFlippingTextBoxEnabled()
```
    Gets a value indicating whether to automatically flip the orientation of the text box if the UpVector actually points downwards.
    The default is true.
    
    Returns:
    
    true if the text box should be flipped if necessary; false otherwise.
    
    See Also:
    
    setAutoFlippingTextBoxEnabled(boolean)
  - isAutoFocusingCanvasOnEditorClosedEnabled
```
public final boolean isAutoFocusingCanvasOnEditorClosedEnabled()
```
    Gets a property that determines whether this mode should try to Node.requestFocus() the Canvas once the editor is closed via a keyboard gesture.
    The default is true
    
    Returns:
    
    The AutoFocusingCanvasOnEditorClosedEnabled.
    
    See Also:
    
    setAutoFocusingCanvasOnEditorClosedEnabled(boolean)
  - isAutoStartEditingEnabled
```
public final boolean isAutoStartEditingEnabled()
```
    Determines whether this mode should automatically fire up the editor once it gets installed.
    If this mode is permanently installed, set this flag to false and set the Editing flag to true in order to start editing.
    
    Returns:
    
    The AutoStartEditingEnabled.
    
    See Also:
    
    setAutoStartEditingEnabled(boolean)
  - isEditing
```
public final boolean isEditing()
```
    Gets the current editing state of the editor.
    Setting a new value will trigger the onBeginEditing() and onCancelEditing() methods respectively.
    
    Returns:
    
    The Editing.
    
    See Also:
    
    setEditing(boolean)
  - isEnabled
```
public boolean isEnabled()
```
    Gets the enabled state of this input mode.
    Clients can use this property to disable or reenable this instance. This will set the Enabled property of the installed Controller so a disabled instance should never try to acquire the input mutex.
    
    Returns:
    
    The Enabled.
    
    See Also:
    
    setEnabled(boolean)
  - isExclusive
```
public final boolean isExclusive()
```
    Gets a value indicating whether this mode will be the only one running when it has the mutex.
    The value of this property will be delegated to the Exclusive property of the Controller.
    
    If this mode is marked as exclusive and has the mutex, all other modes added to the same MultiplexingInputMode will be deactivated. Otherwise it will always run concurrently with all other modes.
    
    Returns:
    
    The Exclusive.
    
    See Also:
    
    setExclusive(boolean)
  - onBeginEditing
```
protected void onBeginEditing()
```
    Called when editing starts.
    Requests the input mutex, and installs the text box.
  - onCanceled
```
protected void onCanceled()
```
    Called after cancel() has been called.
    Can be overridden in subclasses to perform additional actions after the mode has been canceled.
    
    This implementation does nothing.
  - onCancelEditing
```
protected void onCancelEditing()
```
    Called when editing gets canceled.
    Removes the text box and releases the input mutex.
  - onConcurrencyControllerActivated
```
protected void onConcurrencyControllerActivated()
```
    Called after the Active property of the installed ConcurrencyController has been set to true.
    Can be overridden in subclasses to perform additional actions after the mode has been activated.
    
    Overriding implementations should call the base implementation.
  - onConcurrencyControllerDeactivated
```
protected void onConcurrencyControllerDeactivated()
```
    Called after the Active property of the installed ConcurrencyController has been set to false.
    Can be overridden in subclasses to perform additional actions after the mode has been deactivated.
    
    Overriding implementations should call the base implementation.
  - onEditingCanceled
```
protected void onEditingCanceled(TextEventArgs args)
```
    Raises the EditingCanceled event.
    
    Parameters:
    
    args - The event argument
  - onEditingStarted
```
protected void onEditingStarted(TextEventArgs args)
```
    Raises the EditingStarted event.
    
    Parameters:
    
    args - The event argument.
  - onStopEditing
```
protected void onStopEditing()
```
    Called when editing is stopped.
    Triggers the TextEdited event, removes the box and releases the input mutex.
  - onStopped
```
protected void onStopped()
```
    Called after stop() has been called.
    Can be overridden in subclasses to perform additional actions after the mode has been stopped.
    
    This implementation does nothing.
  - onTextEdited
```
protected void onTextEdited(TextEventArgs args)
```
    Raises the TextEdited event.
    
    Parameters:
    
    args - The event arguments.
  - removeEditingCanceledListener
```
public final void removeEditingCanceledListener(IEventHandler<TextEventArgs> editingCanceledEvent)
```
    Removes the given listener for the EditingCanceled event that occurs if the editing has not been finished.
    
    Parameters:
    
    editingCanceledEvent - The listener to remove.
    
    See Also:
    
    addEditingCanceledListener(IEventHandler)
  - removeEditingStartedListener
```
public final void removeEditingStartedListener(IEventHandler<TextEventArgs> editingStartedEvent)
```
    Removes the given listener for the EditingStarted event that occurs when text editing is started.
    
    Parameters:
    
    editingStartedEvent - The listener to remove.
    
    See Also:
    
    addEditingStartedListener(IEventHandler)
  - removeTextEditedListener
```
public final void removeTextEditedListener(IEventHandler<TextEventArgs> textEditedEvent)
```
    Removes the given listener for the TextEdited event that occurs once the text has been edited.
    
    Parameters:
    
    textEditedEvent - The listener to remove.
    
    See Also:
    
    addTextEditedListener(IEventHandler)
  - setAnchor
```
public final void setAnchor(IPoint value)
```
    Sets the anchor of the text box.
    The anchor is the point inside the coordinate system of the text box that shall coincide with the Location in the world coordinate system. The X and Y values are expressed as relative width/height ratios.
    
    Parameters:
    
    value - The Anchor to set.
    
    See Also:
    
    getAnchor()
  - setAutoCommittingOnFocusLostEnabled
```
public final void setAutoCommittingOnFocusLostEnabled(boolean value)
```
    Sets a property that determines whether the text edited should be committed if the focus gets lost or the editing should be canceled.
    The default behavior is to cancel the editing process.
    
    Parameters:
    
    value - The AutoCommittingOnFocusLostEnabled to set.
    
    See Also:
    
    isAutoCommittingOnFocusLostEnabled()
  - setAutoFlippingTextBoxEnabled
```
public final void setAutoFlippingTextBoxEnabled(boolean value)
```
    Sets a value indicating whether to automatically flip the orientation of the text box if the UpVector actually points downwards.
    The default is true.
    
    Parameters:
    
    value - true if the text box should be flipped if necessary; false otherwise.
    
    See Also:
    
    isAutoFlippingTextBoxEnabled()
  - setAutoFocusingCanvasOnEditorClosedEnabled
```
public final void setAutoFocusingCanvasOnEditorClosedEnabled(boolean value)
```
    Sets a property that determines whether this mode should try to Node.requestFocus() the Canvas once the editor is closed via a keyboard gesture.
    The default is true
    
    Parameters:
    
    value - The AutoFocusingCanvasOnEditorClosedEnabled to set.
    
    See Also:
    
    isAutoFocusingCanvasOnEditorClosedEnabled()
  - setAutoStartEditingEnabled
```
public final void setAutoStartEditingEnabled(boolean value)
```
    Determines whether this mode should automatically fire up the editor once it gets installed.
    If this mode is permanently installed, set this flag to false and set the Editing flag to true in order to start editing.
    
    Parameters:
    
    value - The AutoStartEditingEnabled to set.
    
    See Also:
    
    isAutoStartEditingEnabled()
  - setCancelRecognizer
```
public final void setCancelRecognizer(IEventRecognizer value)
```
    Sets the IEventRecognizer to detect when editing the text shall be canceled.
    When the provided KeyEventArgs are recognized, cancel() is called.
    
    Parameters:
    
    value - The cancel recognizer. The default recognizer checks for KeyCode.ESCAPE.
    
    See Also:
    
    getLineBreakRecognizer(), getStopRecognizer(), getCancelRecognizer()
  - setEditing
```
public final void setEditing(boolean value)
```
    Sets the current editing state of the editor.
    Setting a new value will trigger the onBeginEditing() and onCancelEditing() methods respectively.
    
    Parameters:
    
    value - The Editing to set.
    
    See Also:
    
    isEditing()
  - setEditorText
```
public void setEditorText(String text)
```
    Sets the current text of the text input editor.
    
    Parameters:
    
    text - of the text input editor.
  - setEnabled
```
public void setEnabled(boolean value)
```
    Sets the enabled state of this input mode.
    Clients can use this property to disable or reenable this instance. This will set the Enabled property of the installed Controller so a disabled instance should never try to acquire the input mutex.
    
    Parameters:
    
    value - The Enabled to set.
    
    See Also:
    
    isEnabled()
  - setExclusive
```
public final void setExclusive(boolean value)
```
    Sets a value indicating whether this mode will be the only one running when it has the mutex.
    The value of this property will be delegated to the Exclusive property of the Controller.
    
    If this mode is marked as exclusive and has the mutex, all other modes added to the same MultiplexingInputMode will be deactivated. Otherwise it will always run concurrently with all other modes.
    
    Parameters:
    
    value - The Exclusive to set.
    
    See Also:
    
    isExclusive()
  - setLineBreakRecognizer
```
public final void setLineBreakRecognizer(IEventRecognizer value)
```
    Sets the IEventRecognizer to detect the key gesture for new line breaks.
    When the provided KeyEventArgs are recognized, a new line break is inserted at the current curret position.
    
    Parameters:
    
    value - The line break recognizer. The default recognizer checks for KeyCode.ENTER while ModifierKeys.SHORTCUT is pressed.
    
    See Also:
    
    getCancelRecognizer(), getStopRecognizer(), getLineBreakRecognizer()
  - setLocation
```
public final void setLocation(IPoint value)
```
    Sets the location of the text box in world coordinates.
    
    Parameters:
    
    value - The Location to set.
    
    See Also:
    
    getLocation()
  - setPriority
```
public final void setPriority(int value)
```
    The priority of this input mode.
    The priority will influence the order in which the modes will be installed into the canvas control. The lower the priority value, the earlier it will be installed. If two modes are installed using the same priority value, the first one will be installed earlier.
    
    Parameters:
    
    value - The Priority to set.
    
    See Also:
    
    getPriority()
  - setStopRecognizer
```
public final void setStopRecognizer(IEventRecognizer value)
```
    Sets the IEventRecognizer to detect when editing the text shall be stopped.
    When the provided KeyEventArgs are recognized, stop() is called.
    
    Parameters:
    
    value - The stop recognizer. The default recognizer checks for KeyCode.ENTER while ModifierKeys.SHORTCUT is not pressed.
    
    See Also:
    
    getLineBreakRecognizer(), getCancelRecognizer(), getStopRecognizer()
  - setTextBox
```
public final void setTextBox(TextInputControl value)
```
    Sets the text box to use for displaying and editing.
    
    Parameters:
    
    value - The TextBox to set.
    
    See Also:
    
    getTextBox()
  - setUpVector
```
public final void setUpVector(IPoint value)
```
    Sets the point that describes the "up"-vector that will be used to determine the orientation of the text box in the world coordinate system.
    The default is 0, -1.
    
    Parameters:
    
    value - The UpVector to set.
    
    See Also:
    
    getUpVector()
  - showInViewCoordinates
```
protected boolean showInViewCoordinates(SizeD textBoxSize)
```
    Determines whether the text box should be displayed in the view coordinate system instead of in the world coordinate system.
    If enabled, the zoom value used to scale the text box is 1. Otherwise, the zoom value is determined by the zoom level of the CanvasControl limited by the values returned by the methods getMinimumZoom(SizeD) and getMaximumZoom(SizeD).
    
    Parameters:
    
    textBoxSize - The size of the text box to display.
    
    Returns:
    
    Whether to show it in the view coordinate system. The default implementation always returns false.
    
    See Also:
    
    getMinimumZoom(SizeD), getMaximumZoom(SizeD)
  - stop
```
public boolean stop()
```
    Stops editing and returns true.
    
    Specified by:
    
    stop in interface IInputMode
    
    Returns:
    
    base.Stop()
    
    See Also:
    
    IInputMode.cancel()
  - uninstall
```
public void uninstall(IInputModeContext context)
```
    Uninstalls this mode from the given context.
    This code should clean up all changes made to the canvas in the IInputMode.install(IInputModeContext, ConcurrencyController) method. After a mode has been uninstalled it can be installed again into the same or another canvas.
    
    Overriding implementations should call the base implementation after their own code.
    
    Specified by:
    
    uninstall in interface IInputMode
    
    Parameters:
    
    context - The context to deregister from. This is the same instance that had been passed to IInputMode.install(IInputModeContext, ConcurrencyController) during installation.
  - uninstallTextBox
```
protected void uninstallTextBox()
```
    Called to remove the text box from the application. The default implementation removes the node from the scene graph and requests focus on the CanvasControl.

Class TextEditorInputMode

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

editorText

Constructor Detail

TextEditorInputMode

TextEditorInputMode

Method Detail

addEditingCanceledListener

addEditingStartedListener

addTextEditedListener

adjustPosition

cancel

clear

createTextBox

editorTextProperty

ensureVisible

getAnchor

getCancelRecognizer

getController

getEditorText

getInputModeContext

getLineBreakRecognizer

getLocation

getMaximumZoom

getMinimumZoom

getPriority

getStopRecognizer

getTextBox

getTextBoxBounds

getUpVector

install

installTextBox

isAutoCommittingOnFocusLostEnabled

isAutoFlippingTextBoxEnabled

isAutoFocusingCanvasOnEditorClosedEnabled

isAutoStartEditingEnabled

isEditing

isEnabled

isExclusive

onBeginEditing

onCanceled

onCancelEditing

onConcurrencyControllerActivated

onConcurrencyControllerDeactivated

onEditingCanceled

onEditingStarted

onStopEditing

onStopped

onTextEdited

removeEditingCanceledListener

removeEditingStartedListener

removeTextEditedListener

setAnchor

setAutoCommittingOnFocusLostEnabled

setAutoFlippingTextBoxEnabled

setAutoFocusingCanvasOnEditorClosedEnabled

setAutoStartEditingEnabled

setCancelRecognizer

setEditing

setEditorText

setEnabled

setExclusive

setLineBreakRecognizer

setLocation

setPriority

setStopRecognizer

setTextBox

setUpVector

showInViewCoordinates

stop

uninstall

uninstallTextBox