JavaFX: Bringing Rich Experiences To All the Screens Of Your Life

Profile: desktop, common

Overview

Defines the base class for all inline editors. An inline editor provides the user interface for viewing and editing of a value of a specific type within a Grid control.

Variable Summary

accessnametypeCan ReadCan InitCan WriteDefault Valuedescription
protectedbehaviorInlineEditorBehaviorsubclasssubclasssubclass

The associated behavior.

publicboundsBounds

A rectangle defining the position of the editor within the scene.

publicitemObject

The object whose member value is being edited.

publicmemberString

The name of the member, which is being edited.

protectednodeNodesubclasssubclasssubclass

The node providing the editor's user interface.

publiconEndEditfunction(:boolean):Void

Invoked when the editor is being closed.

Invoked when the editor is being closed. In the default implementation this happens when the user clicks outside of the editor or when the endEdit method is called explicitly.

 
publiconNextCellfunction():Void

Invoke this method to close the editor and move to the next cell in the current grid row.

Invoke this method to close the editor and move to the next cell in the current grid row. For example this method can be invoked in response to hitting the TAB key in a text editor.

 
publiconNextRowfunction():Void

Invoke this method to close the editor and move to the next row in the grid.

Invoke this method to close the editor and move to the next row in the grid. For example this method can be invoked in response to hitting the DOWN key in a text editor.

 
publiconPreviousCellfunction():Void

Invoke this method to close the editor and move to the previous cell in the current grid row.

Invoke this method to close the editor and move to the previous cell in the current grid row. For example this method can be invoked in response to hitting the SHIFT+TAB key in a text editor.

 
publiconPreviousRowfunction():Void

Invoke this method to close the editor and move to the previous row in the grid.

Invoke this method to close the editor and move to the previous row in the grid. For example this method can be invoked in response to hitting the UP key in a text editor.

 
publicsceneScene

The scene where the editor will appear.

Inherited Variables

Function Summary

public endEdit(commit: Boolean) : Void

Finalizes the editing operation by either accepting or rejecting the changes made in the editor.

Finalizes the editing operation by either accepting or rejecting the changes made in the editor.

Parameters
commit
A flag specifying whether the operation should be accepted or rejected.
 
public abstract newValue() : java.lang.Object

Returns the edited value.

Returns the edited value.

Returns
Object
An object, which should be of the appropriate type as the type of the member being edited.
 
public abstract newValueAsString() : java.lang.String

Returns a string representation of the edited value.

Returns a string representation of the edited value.

Returns
String
A string value representing the new value.
 
public startEdit() : Void

Initiates an editing operation.

Initiates an editing operation. Calling this method adds node into the underlying scene.

 

Inherited Functions