Package ghidra.util.table.field
Class FunctionInlineSettingsDefinition
java.lang.Object
ghidra.util.table.field.FunctionInlineSettingsDefinition
- All Implemented Interfaces:
BooleanSettingsDefinition
,SettingsDefinition
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Removes any values in the given settings object assocated with this settings definitionvoid
copySetting
(Settings srcSettings, Settings destSettings) Copies any setting value associated with this settings definition from the srcSettings settings to the destSettings.Returns a description of this settings definitiongetName()
Returns the display name of this SettingsDefinitionGet theSettings
key which is used when storing a key/value entry.boolean
gets the value for this SettingsDefinition given a Settings object.getValueString
(Settings settings) Get the setting value as a string which corresponds to this definition.boolean
Determine if a setting value has been storedvoid
Sets the given value into the given settings object using this settingsDefinition as the key.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface ghidra.docking.settings.BooleanSettingsDefinition
hasSameValue
-
Field Details
-
DEF
-
-
Constructor Details
-
FunctionInlineSettingsDefinition
public FunctionInlineSettingsDefinition()
-
-
Method Details
-
getValue
Description copied from interface:BooleanSettingsDefinition
gets the value for this SettingsDefinition given a Settings object.- Specified by:
getValue
in interfaceBooleanSettingsDefinition
- Parameters:
settings
- the set of Settings values for a particular location or null for default value.- Returns:
- the values for this settings object given the context.
-
getValueString
Description copied from interface:SettingsDefinition
Get the setting value as a string which corresponds to this definition. A default value string will be returned if a setting has not been stored.- Specified by:
getValueString
in interfaceSettingsDefinition
- Parameters:
settings
- settings- Returns:
- value string or null if not set and default has not specified by this definition
-
setValue
Description copied from interface:BooleanSettingsDefinition
Sets the given value into the given settings object using this settingsDefinition as the key.- Specified by:
setValue
in interfaceBooleanSettingsDefinition
- Parameters:
settings
- the settings object to store the value in.value
- the value to store in the settings object using this settingsDefinition as the key.
-
copySetting
Description copied from interface:SettingsDefinition
Copies any setting value associated with this settings definition from the srcSettings settings to the destSettings.- Specified by:
copySetting
in interfaceSettingsDefinition
- Parameters:
srcSettings
- the settings to be copieddestSettings
- the settings to be updated.
-
clear
Description copied from interface:SettingsDefinition
Removes any values in the given settings object assocated with this settings definition- Specified by:
clear
in interfaceSettingsDefinition
- Parameters:
settings
- the settings object to be cleared.
-
getDescription
Description copied from interface:SettingsDefinition
Returns a description of this settings definition- Specified by:
getDescription
in interfaceSettingsDefinition
- Returns:
- setting description
-
getName
Description copied from interface:SettingsDefinition
Returns the display name of this SettingsDefinition- Specified by:
getName
in interfaceSettingsDefinition
- Returns:
- display name for setting
-
getStorageKey
Description copied from interface:SettingsDefinition
Get theSettings
key which is used when storing a key/value entry.- Specified by:
getStorageKey
in interfaceSettingsDefinition
- Returns:
- settings storage key
-
hasValue
Description copied from interface:SettingsDefinition
Determine if a setting value has been stored- Specified by:
hasValue
in interfaceSettingsDefinition
- Parameters:
settings
- stored settings- Returns:
- true if a value has been stored, else false
-