Package ghidra.framework.options
Class ToolOptions
java.lang.Object
ghidra.framework.options.AbstractOptions
ghidra.framework.options.ToolOptions
- All Implemented Interfaces:
Options
Class to manage a set of option name/value pairs for a category.
The values may be primitives or WrappedOption
s that are containers for primitive
components.
The name/value pair has an owner so that the option name can be removed from the Options object when it is no longer being used.
Note: Property Names can have Options.DELIMITER
characters to create a hierarchy.
So too can sub-options accessed via AbstractOptions.getOptions(String)
.
The Options Dialog shows the delimited hierarchy in tree format.
-
Nested Class Summary
Nested classes/interfaces inherited from class ghidra.framework.options.AbstractOptions
AbstractOptions.AliasBinding
-
Field Summary
Fields inherited from class ghidra.framework.options.AbstractOptions
aliasMap, categoryHelpMap, listeners, name, optionsEditorMap, SUPPORTED_CLASSES, themeListener, themeToOptionMap, valueMap
Fields inherited from interface ghidra.framework.options.Options
DELIMITER, DELIMITER_STRING, ILLEGAL_DELIMITER
-
Constructor Summary
ConstructorDescriptionToolOptions
(String name) ToolOptions
(org.jdom.Element root) Construct a new Options object from the given XML element. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add the options change listener.copy()
void
copyOptions
(Options newOptions) Adds all the options name/value pairs to this Options.protected Option
createRegisteredOption
(String optionName, OptionType type, String description, HelpLocation help, Object defaultValue, PropertyEditor editor) protected Option
createUnregisteredOption
(String optionName, OptionType type, Object defaultValue) boolean
org.jdom.Element
getXmlRoot
(boolean includeDefaultBindings) Return an XML element for the option names and values.int
hashCode()
protected boolean
notifyOptionChanged
(String optionName, Object oldValue, Object newValue) void
registerOptions
(ToolOptions oldOptions) void
Remove the options change listener.void
Check each option to ensure that an owner is still registered for it; if there is no owner, then remove the option.void
takeListeners
(ToolOptions oldOptions) void
Methods inherited from class ghidra.framework.options.AbstractOptions
contains, createAlias, dispose, findPropertyEditor, getActionTrigger, getBoolean, getByteArray, getCategoryHelpLocation, getChildOptions, getColor, getCustomOption, getDate, getDefaultValue, getDefaultValueAsString, getDescription, getDouble, getEnum, getFile, getFloat, getFont, getHelpLocation, getID, getInt, getKeyStroke, getLeafOptionNames, getLong, getName, getObject, getOption, getOptionNames, getOptions, getOptionsEditor, getOptionsEditor, getOptionsHelpLocation, getPropertyEditor, getRegisteredPropertyEditor, getString, getType, getValueAsString, isAlias, isDefaultValue, isRegistered, putObject, putObject, registerOption, registerOption, registerOption, registerOptionsEditor, registerOptionsEditor, registerThemeColorBinding, registerThemeFontBinding, removeOption, restoreDefaultValue, restoreDefaultValues, setActionTrigger, setBoolean, setByteArray, setCategoryHelpLocation, setColor, setCustomOption, setDate, setDouble, setEnum, setFile, setFloat, setFont, setInt, setKeyStroke, setLong, setName, setOptionsHelpLocation, setString, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface ghidra.framework.options.Options
registerOption, registerOptionsEditor
-
Field Details
-
PRIMITIVE_CLASSES
-
WRAPPABLE_CLASSES
-
XML_ELEMENT_NAME
- See Also:
-
-
Constructor Details
-
ToolOptions
-
ToolOptions
public ToolOptions(org.jdom.Element root) Construct a new Options object from the given XML element.- Parameters:
root
- XML that contains the set of options to restore
-
-
Method Details
-
copy
-
getXmlRoot
public org.jdom.Element getXmlRoot(boolean includeDefaultBindings) Return an XML element for the option names and values. Note: only those options which have been explicitly set will be included.- Parameters:
includeDefaultBindings
- true to include default key binding values in the xml- Returns:
- the xml root element
-
addOptionsChangeListener
Add the options change listener. NOTE: The Options uses WeakReferences to manage the listeners; this means that you must supply a listener and maintain a handle to it, or else the listener will be garbage collected and will never get called. So for this reason, do not create the listener in an anonymous inner class.- Parameters:
l
- listener to add
-
takeListeners
-
removeOptionsChangeListener
Remove the options change listener.- Parameters:
l
- listener to remove
-
removeUnusedOptions
public void removeUnusedOptions()Check each option to ensure that an owner is still registered for it; if there is no owner, then remove the option. -
copyOptions
Adds all the options name/value pairs to this Options.- Parameters:
newOptions
- the new options into which the current options values will be placed
-
hashCode
public int hashCode() -
equals
-
validateOptions
public void validateOptions() -
registerOptions
-
createRegisteredOption
protected Option createRegisteredOption(String optionName, OptionType type, String description, HelpLocation help, Object defaultValue, PropertyEditor editor) - Specified by:
createRegisteredOption
in classAbstractOptions
-
createUnregisteredOption
- Specified by:
createUnregisteredOption
in classAbstractOptions
-
notifyOptionChanged
- Specified by:
notifyOptionChanged
in classAbstractOptions
-