jidefx.scene.control.editor

Class EditorManager

java.lang.Object

jidefx.scene.control.editor.EditorManager

public class EditorManager
extends java.lang.Object

A global object that can register editor with a type and a EditorContext.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_EDITOR_MANAGER

Constructor Summary

Constructors

Constructor and Description
EditorManager()

Method Summary

Modifier and Type	Method and Description
void	clear()
static EditorManager	createInstance() Creates a new instance of the EditorManager.
Editor	getEditor(java.lang.Class<?> clazz) Gets the registered editor using default context.
Editor	getEditor(java.lang.Class<?> clazz, EditorContext context) Gets the registered editor.
EditorContext[]	getEditorContexts(java.lang.Class<?> clazz) Gets the available EditorContext registered with the class.
static EditorManager	getInstance() Gets the default instance of the EditorManager.
static EditorManager	getInstance(javafx.scene.Node node) Gets the EditorManager from the node if the node has an EditorManager defined on the Properties.
void	initDefaultEditors() Initial the default editors.
boolean	isAutoInit() Checks the value of autoInit.
void	registerEditor(java.lang.Class<?> clazz, java.util.function.Supplier<Editor> editorFactory) Registers an editor with a class and default context.
void	registerEditor(java.lang.Class<?> clazz, java.util.function.Supplier<Editor> editorFactory, EditorContext context) Registers a editor with a class and a context.
void	resetInit() If initDefaultEditors() is called once, calling it again will have no effect because an internal flag is set.
void	setAutoInit(boolean autoInit) Sets autoInit to true or false.
void	unregisterAllEditors() Unregisters all the editors which registered before.
void	unregisterAllEditors(java.lang.Class<?> clazz) Unregisters all editors which register with the class.
void	unregisterEditor(java.lang.Class<?> clazz, EditorContext context) Unregisters the editor which registers with the class and the context.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_EDITOR_MANAGER

public static final java.lang.String PROPERTY_EDITOR_MANAGER

See Also:

Constant Field Values

Constructor Detail

EditorManager

public EditorManager()

Method Detail

createInstance

public static EditorManager createInstance()

Creates a new instance of the EditorManager.

Returns:

a new instance of the EditorManager.

getInstance

public static EditorManager getInstance()

Gets the default instance of the EditorManager.

Returns:

the default instance of the EditorManager.

getInstance

public static EditorManager getInstance(javafx.scene.Node node)

Gets the EditorManager from the node if the node has an EditorManager defined on the Properties. If not there, return the default instance.

Parameters:

node - the node

Returns:

an EditorManager.

registerEditor

public void registerEditor(java.lang.Class<?> clazz,
                           java.util.function.Supplier<Editor> editorFactory,
                           EditorContext context)

Registers a editor with a class and a context.

Parameters:

clazz - the type

editorFactory - the editor factory

context - the editor context

registerEditor

public void registerEditor(java.lang.Class<?> clazz,
                           java.util.function.Supplier<Editor> editorFactory)

Registers an editor with a class and default context. If no context is specified, this default editor will be used for that type.

Parameters:

clazz - the type

editorFactory - the editor factory

unregisterEditor

public void unregisterEditor(java.lang.Class<?> clazz,
                             EditorContext context)

Unregisters the editor which registers with the class and the context.

Parameters:

clazz - the type of which the editor will be unregistered.

context - the editor context.

unregisterAllEditors

public void unregisterAllEditors(java.lang.Class<?> clazz)

Unregisters all editors which register with the class.

Parameters:

clazz - the type of which the editor will be unregistered.

unregisterAllEditors

public void unregisterAllEditors()

Unregisters all the editors which registered before.

getEditor

public Editor getEditor(java.lang.Class<?> clazz,
                        EditorContext context)

Gets the registered editor.

Parameters:

clazz - the type.

context - the editor context.

Returns:

the registered editor

getEditor

public Editor getEditor(java.lang.Class<?> clazz)

Gets the registered editor using default context.

Parameters:

clazz - the type.

Returns:

the registered editor

isAutoInit

public boolean isAutoInit()

Checks the value of autoInit.

Returns:

true or false.

See Also:

setAutoInit(boolean)

setAutoInit

public void setAutoInit(boolean autoInit)

Sets autoInit to true or false. If autoInit is true, whenever someone tries to call methods like as getEditor, initDefaultEditors() will be called if it has never be called. By default, autoInit is true.

This might affect the behavior if users provide their own Editors and want to overwrite default Editors. In this case, instead of depending on autoInit to initialize default Editors, you should call initDefaultEditors() first, then call registerEditor to add your own Editors.

Parameters:

autoInit - true or false.

getEditorContexts

public EditorContext[] getEditorContexts(java.lang.Class<?> clazz)

Gets the available EditorContext registered with the class.

Parameters:

clazz - the class.

Returns:

the available EditorContexts.

initDefaultEditors

public void initDefaultEditors()

Initial the default editors.

resetInit

public void resetInit()

If initDefaultEditors() is called once, calling it again will have no effect because an internal flag is set. This method will reset the internal flag so that you can call initDefaultEditors() in case you unregister all editors using unregisterAllEditors().

clear

public void clear()