public class GenericObjectEditor extends Object implements PropertyEditor, CustomPanelSupplier
USE_DYNAMIC
is false
) the
objects have been defined as editable in the GenericObjectEditor
configuration file, which lists possible values that can be selected from,
and themselves configured. The configuration file is called
"GenericObjectEditor.props" and may live in either the location given by
"user.home" or the current directory (this last will take precedence), and a
default properties file is read from the Weka distribution. For speed, the
properties file is read only once when the class is first loaded -- this may
need to be changed if we ever end up running in a Java OS ;-). UseDynamic
property
of the GenericPropertiesCreator props file is set to true
)
then the classes to list are discovered by the
GenericPropertiesCreator
class (it checks the complete classpath).GenericPropertiesCreator
,
GenericPropertiesCreator.useDynamic()
,
GenericPropertiesCreator.CREATOR_FILE
,
ClassDiscovery
Modifier and Type | Class and Description |
---|---|
class |
GenericObjectEditor.CapabilitiesFilterDialog
A dialog for selecting Capabilities to look for in the GOE tree.
|
class |
GenericObjectEditor.GOEPanel
Handles the GUI side of editing values.
|
class |
GenericObjectEditor.GOETreeNode
A specialized TreeNode for supporting filtering via Capabilities.
|
class |
GenericObjectEditor.JTreePopupMenu
Creates a popup menu containing a tree that is aware
of the screen dimensions.
|
Modifier and Type | Field and Description |
---|---|
protected static Properties |
EDITOR_PROPERTIES
Contains the editor properties.
|
static String |
GUIEDITORS_PROPERTY_FILE
the properties files containing the class/editor mappings.
|
protected Object |
m_Backup
Holds a copy of the current object that can be reverted to
if the user decides to cancel.
|
protected boolean |
m_canChangeClassInDialog
whether the class can be changed.
|
protected Capabilities |
m_CapabilitiesFilter
for filtering the tree based on the Capabilities of the leaves.
|
protected Class |
m_ClassType
The Class of objects being edited.
|
protected GenericObjectEditor.GOEPanel |
m_EditorComponent
The GUI component for editing values, created when needed.
|
protected static boolean |
m_EditorsRegistered
whether the Weka Editors were already registered.
|
protected boolean |
m_Enabled
True if the GUI component is needed.
|
protected Object |
m_Object
The object being configured.
|
protected Hashtable |
m_ObjectNames
The model containing the list of names to select from.
|
protected PropertyPanel |
m_ObjectPropertyPanel
The property panel created for the objects.
|
protected PropertyChangeSupport |
m_Support
Handles property change notification.
|
protected GenericObjectEditor.GOETreeNode |
m_treeNodeOfCurrentObject
The tree node of the current object so we can re-select it for the user.
|
protected static String |
PROPERTY_FILE
The name of the properties file.
|
Constructor and Description |
---|
GenericObjectEditor()
Default constructor.
|
GenericObjectEditor(boolean canChangeClassInDialog)
Constructor that allows specifying whether it is possible
to change the class within the editor dialog.
|
Modifier and Type | Method and Description |
---|---|
protected void |
addChildrenToTree(GenericObjectEditor.GOETreeNode tree,
HierarchyPropertyParser hpp)
Recursively builds a JTree from an object heirarchy.
|
void |
addPropertyChangeListener(PropertyChangeListener l)
Adds a PropertyChangeListener who will be notified of value changes.
|
protected void |
classSelected(String className)
Called when the user selects an class type to change to.
|
protected JButton |
createChooseClassButton()
Creates a button that when clicked will enable the user to change
the class of the object being edited.
|
protected JTree |
createTree(Hashtable hpps)
Creates a JTree from an object heirarchy.
|
String |
getAsText()
Returns null as we don't support getting/setting values as text.
|
Object |
getBackup()
Returns the backup object (may be null if there is no
backup.
|
boolean |
getCanChangeClassInDialog()
Returns whether the user can change the class in the dialog.
|
Capabilities |
getCapabilitiesFilter()
Returns the current Capabilities filter, can be null.
|
JPopupMenu |
getChooseClassPopupMenu()
Returns a popup menu that allows the user to change
the class of object.
|
protected Hashtable |
getClassesFromProperties()
Called when the class of object being edited changes.
|
protected String |
getClassnameFromPath(TreePath path)
creates a classname from the given path.
|
static Vector<String> |
getClassnames(String property)
Returns the available classnames for a certain property in the
props file.
|
Component |
getCustomEditor()
Returns the array editing component.
|
JPanel |
getCustomPanel()
Gets the custom panel used for editing the object.
|
String |
getJavaInitializationString()
Supposedly returns an initialization string to create a Object
identical to the current one, including it's state, but this doesn't
appear possible given that the initialization string isn't supposed to
contain multiple statements.
|
protected static String |
getRootFromClass(String clsname,
String separator)
returns the name of the root element of the given class name,
null if it doesn't contain the separator. |
String[] |
getTags()
Returns null as we don't support getting values as tags.
|
Object |
getValue()
Gets the current Object.
|
boolean |
isPaintable()
Returns true to indicate that we can paint a representation of the
Object.
|
static void |
main(String[] args)
Tests out the Object editor from the command line.
|
static Object |
makeCopy(Object source)
Makes a copy of an object using serialization.
|
void |
paintValue(Graphics gfx,
Rectangle box)
Paints a representation of the current Object.
|
static void |
registerEditors()
registers all the editors in Weka.
|
void |
removeCapabilitiesFilter()
Removes the current Capabilities filter.
|
void |
removePropertyChangeListener(PropertyChangeListener l)
Removes a PropertyChangeListener.
|
void |
setAsText(String text)
Returns null as we don't support getting/setting values as text.
|
void |
setCanChangeClassInDialog(boolean value)
Sets whether the user can change the class in the dialog.
|
void |
setCapabilitiesFilter(Capabilities value)
Sets the capabilities to use for filtering.
|
void |
setClassType(Class type)
Sets the class of values that can be edited.
|
void |
setDefaultValue()
Sets the current object to be the default, taken as the first item in
the chooser.
|
void |
setEnabled(boolean newVal)
Sets whether the editor is "enabled", meaning that the current
values will be painted.
|
protected void |
setObject(Object c)
Sets the current Object.
|
void |
setValue(Object o)
Sets the current Object.
|
static Hashtable |
sortClassesByRoot(String classes)
parses the given string of classes separated by ", " and returns the
a hashtable with as many entries as there are different root elements in
the class names (the key is the root element).
|
boolean |
supportsCustomEditor()
Returns true because we do support a custom editor.
|
protected void |
updateObjectNames()
Updates the list of selectable object names, adding any new names to the list.
|
protected Object m_Object
protected Object m_Backup
protected PropertyChangeSupport m_Support
protected Class m_ClassType
protected Hashtable m_ObjectNames
protected GenericObjectEditor.GOEPanel m_EditorComponent
protected boolean m_Enabled
protected static String PROPERTY_FILE
protected static Properties EDITOR_PROPERTIES
public static final String GUIEDITORS_PROPERTY_FILE
protected GenericObjectEditor.GOETreeNode m_treeNodeOfCurrentObject
protected PropertyPanel m_ObjectPropertyPanel
protected boolean m_canChangeClassInDialog
protected static boolean m_EditorsRegistered
protected Capabilities m_CapabilitiesFilter
public GenericObjectEditor()
public GenericObjectEditor(boolean canChangeClassInDialog)
canChangeClassInDialog
- whether the user can change the classpublic static void registerEditors()
public void setCanChangeClassInDialog(boolean value)
value
- if true then the user can change the classpublic boolean getCanChangeClassInDialog()
public Object getBackup()
protected static String getRootFromClass(String clsname, String separator)
null
if it doesn't contain the separator.clsname
- the full classnameseparator
- the separatorpublic static Hashtable sortClassesByRoot(String classes)
classes
- the classnames to work onprotected Hashtable getClassesFromProperties()
protected void updateObjectNames()
public void setEnabled(boolean newVal)
newVal
- a value of type 'boolean'public void setClassType(Class type)
type
- a value of type 'Class'public void setDefaultValue()
public void setValue(Object o)
setValue
in interface PropertyEditor
o
- an object that must be a Object.protected void setObject(Object c)
c
- a value of type 'Object'public Object getValue()
getValue
in interface PropertyEditor
public String getJavaInitializationString()
getJavaInitializationString
in interface PropertyEditor
public boolean isPaintable()
isPaintable
in interface PropertyEditor
public void paintValue(Graphics gfx, Rectangle box)
paintValue
in interface PropertyEditor
gfx
- the graphics context to usebox
- the area we are allowed to paint intopublic String getAsText()
getAsText
in interface PropertyEditor
public void setAsText(String text)
setAsText
in interface PropertyEditor
text
- the text valueIllegalArgumentException
- as we don't support
getting/setting values as text.public String[] getTags()
getTags
in interface PropertyEditor
public boolean supportsCustomEditor()
supportsCustomEditor
in interface PropertyEditor
public Component getCustomEditor()
getCustomEditor
in interface PropertyEditor
public void addPropertyChangeListener(PropertyChangeListener l)
addPropertyChangeListener
in interface PropertyEditor
l
- a value of type 'PropertyChangeListener'public void removePropertyChangeListener(PropertyChangeListener l)
removePropertyChangeListener
in interface PropertyEditor
l
- a value of type 'PropertyChangeListener'public JPanel getCustomPanel()
getCustomPanel
in interface CustomPanelSupplier
protected JButton createChooseClassButton()
protected String getClassnameFromPath(TreePath path)
path
- the path to generate the classname frompublic JPopupMenu getChooseClassPopupMenu()
protected JTree createTree(Hashtable hpps)
hpps
- the hierarchy of objects to mirror in the treeprotected void addChildrenToTree(GenericObjectEditor.GOETreeNode tree, HierarchyPropertyParser hpp)
tree
- the root of the tree to add children tohpp
- the hierarchy of objects to mirror in the treeprotected void classSelected(String className)
className
- the name of the class that was selectedpublic void setCapabilitiesFilter(Capabilities value)
value
- the object to get the filter capabilities frompublic Capabilities getCapabilitiesFilter()
public void removeCapabilitiesFilter()
public static Object makeCopy(Object source) throws Exception
source
- the object to copyException
- if the copy failspublic static Vector<String> getClassnames(String property)
property
- the property to get the classnames forpublic static void main(String[] args)
args
- may contain the class name of a Object to editCopyright © 2015 University of Waikato, Hamilton, NZ. All rights reserved.