OpenJDK 27 · java.beans.PropertyEditorManager · APIdia, the JavaDoc alternative

The PropertyEditorManager can be used to locate a property editor for any given type name. This property editor must support the java.beans.PropertyEditor interface for editing a given object.

The PropertyEditorManager uses three techniques for locating an editor for a given type. First, it provides a registerEditor method to allow an editor to be specifically registered for a given type. Second it tries to locate a suitable class by adding "Editor" to the full qualified classname of the given type (e.g. "foo.bah.FozEditor"). Finally it takes the simple classname (without the package name) adds "Editor" to it and looks in a search-path of packages for a matching class.

So for an input class foo.bah.Fred, the PropertyEditorManager would first look in its tables to see if an editor had been registered for foo.bah.Fred and if so use that. Then it will look for a foo.bah.FredEditor class. Then it will look for (say) standardEditorsPackage.FredEditor class.

Default PropertyEditors will be provided for the Java primitive types "boolean", "byte", "short", "int", "long", "float", and "double"; and for the classes java.lang.String. java.awt.Color, and java.awt.Font.

Constructor Summary

Access	Constructor and Description
public	PropertyEditorManager() Constructs a `PropertyEditorManager`.

Method Summary

Modifier and Type	Method and Description
public static PropertyEditor	Returns: An editor object for the given target class. The result is null if no suitable editor can be found. findEditor(Class<?> The Class object for the type to be edited targetType) Locate a value editor for a given target type.
public static String[]	Returns: The array of package names that will be searched in order to find property editors. The default value for this array is implementation-dependent, e.g. Sun implementation initially sets to {"sun.beans.editors"}. getEditorSearchPath() Gets the package names that will be searched for property editors.
public static void	registerEditor(Class<?> the class object of the type to be edited targetType, Class<?> the class object of the editor class editorClass) Registers an editor class to edit values of the given target class.
public static void	setEditorSearchPath(String[] Array of package names. path) Change the list of package names that will be used for finding property editors.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

PropertyEditorManager	back to summary
public PropertyEditorManager() Constructs a `PropertyEditorManager`.

Method Detail

findEditor	back to summary
public static PropertyEditor findEditor(Class<?> targetType) Locate a value editor for a given target type. Parameters targetType:Class<?> The Class object for the type to be edited Returns:PropertyEditor An editor object for the given target class. The result is null if no suitable editor can be found.

findEditor

back to summary

public static PropertyEditor findEditor(Class<?> targetType)

Locate a value editor for a given target type.

Parameters

targetType:Class<?>: The Class object for the type to be edited

Returns:PropertyEditor

An editor object for the given target class. The result is null if no suitable editor can be found.

getEditorSearchPath	back to summary
public static String[] getEditorSearchPath() Gets the package names that will be searched for property editors. Returns:String[] The array of package names that will be searched in order to find property editors. The default value for this array is implementation-dependent, e.g. Sun implementation initially sets to {"sun.beans.editors"}.

getEditorSearchPath

back to summary

public static String[] getEditorSearchPath()

Gets the package names that will be searched for property editors.

Returns:String[]

The array of package names that will be searched in order to find property editors.

The default value for this array is implementation-dependent, e.g. Sun implementation initially sets to {"sun.beans.editors"}.

registerEditor back to summary

registerEditor	back to summary
public static void registerEditor(Class<?> targetType, Class<?> editorClass) Registers an editor class to edit values of the given target class. If the editor class is `null`, then any existing definition will be removed. Thus this method can be used to cancel the registration. The registration is canceled automatically if either the target or editor class is unloaded. Parameters targetType:Class<?> the class object of the type to be edited editorClass:Class<?> the class object of the editor class

public static void registerEditor(Class<?> targetType, Class<?> editorClass)

Registers an editor class to edit values of the given target class. If the editor class is null, then any existing definition will be removed. Thus this method can be used to cancel the registration. The registration is canceled automatically if either the target or editor class is unloaded.

Parameters

targetType:Class<?>: the class object of the type to be edited
editorClass:Class<?>: the class object of the editor class

setEditorSearchPath	back to summary
public static void setEditorSearchPath(String[] path) Change the list of package names that will be used for finding property editors. Parameters path:String[] Array of package names.

setEditorSearchPath

back to summary

public static void setEditorSearchPath(String[] path)

Change the list of package names that will be used for finding property editors.

Parameters

path:String[]: Array of package names.

public Class PropertyEditorManager

Constructor Summary

Method Summary

Constructor Detail

Method Detail