Package ghidra.docking.settings
Class IntegerSignednessFormattingModeSettingsDefinition
- java.lang.Object
-
- ghidra.docking.settings.IntegerSignednessFormattingModeSettingsDefinition
-
- All Implemented Interfaces:
EnumSettingsDefinition
,SettingsDefinition
public class IntegerSignednessFormattingModeSettingsDefinition extends java.lang.Object implements EnumSettingsDefinition
The settings definition for the numeric display format for handling signed values.
-
-
Field Summary
Fields Modifier and Type Field Description static IntegerSignednessFormattingModeSettingsDefinition
DEF
static IntegerSignednessFormattingModeSettingsDefinition
DEF_SIGNED
static IntegerSignednessFormattingModeSettingsDefinition
DEF_UNSIGNED
protected static java.lang.String
SIGN_FORMAT
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear(Settings settings)
Removes any values in the given settings object assocated with this settings definitionvoid
copySetting(Settings settings, Settings destSettings)
Copies any setting value associated with this settings definition from the srcSettings settings to the destSettings.int
getChoice(Settings settings)
Returns the current value for this settingsjava.lang.String
getDescription()
Returns a description of this settings definitionjava.lang.String
getDisplayChoice(int value, Settings s1)
Returns the String for the given enum valuejava.lang.String
getDisplayChoice(Settings settings)
java.lang.String[]
getDisplayChoices(Settings settings)
Gets the list of choices as strings based on the current settingsSignednessFormatMode
getFormatMode(Settings settings)
Returns the format based on the specified settingsjava.lang.String
getName()
Returns the name of this SettingsDefinitionboolean
hasValue(Settings setting)
void
setChoice(Settings settings, int value)
Sets the given value into the settings object using this definition as a keyvoid
setDisplayChoice(Settings settings, java.lang.String choice)
Sets the settings object to the enum value indicating the specified choice as a string.void
setFormatMode(Settings settings, SignednessFormatMode mode)
Set, or clear ifmode
is null, the new mode in the provided settings
-
-
-
Field Detail
-
SIGN_FORMAT
protected static final java.lang.String SIGN_FORMAT
- See Also:
- Constant Field Values
-
DEF
public static final IntegerSignednessFormattingModeSettingsDefinition DEF
-
DEF_SIGNED
public static final IntegerSignednessFormattingModeSettingsDefinition DEF_SIGNED
-
DEF_UNSIGNED
public static final IntegerSignednessFormattingModeSettingsDefinition DEF_UNSIGNED
-
-
Method Detail
-
getFormatMode
public SignednessFormatMode getFormatMode(Settings settings)
Returns the format based on the specified settings- Parameters:
settings
- the instance settings or null for default value.- Returns:
- the format mode
-
getChoice
public int getChoice(Settings settings)
Description copied from interface:EnumSettingsDefinition
Returns the current value for this settings- Specified by:
getChoice
in interfaceEnumSettingsDefinition
- Parameters:
settings
- The settings to search- Returns:
- the value for the settingsDefintions
-
setFormatMode
public void setFormatMode(Settings settings, SignednessFormatMode mode)
Set, or clear ifmode
is null, the new mode in the provided settings- Parameters:
settings
- settings objectmode
- new value to assign, or null to clear
-
setChoice
public void setChoice(Settings settings, int value)
Description copied from interface:EnumSettingsDefinition
Sets the given value into the settings object using this definition as a key- Specified by:
setChoice
in interfaceEnumSettingsDefinition
- Parameters:
settings
- the settings to store the value.value
- the settings value to be stored.
-
getDisplayChoices
public java.lang.String[] getDisplayChoices(Settings settings)
Description copied from interface:EnumSettingsDefinition
Gets the list of choices as strings based on the current settings- Specified by:
getDisplayChoices
in interfaceEnumSettingsDefinition
- Parameters:
settings
- the instance settings- Returns:
- an array of strings which represent valid choices based on the current settings.
-
getName
public java.lang.String getName()
Description copied from interface:SettingsDefinition
Returns the name of this SettingsDefinition- Specified by:
getName
in interfaceSettingsDefinition
-
getDescription
public java.lang.String getDescription()
Description copied from interface:SettingsDefinition
Returns a description of this settings definition- Specified by:
getDescription
in interfaceSettingsDefinition
-
getDisplayChoice
public java.lang.String getDisplayChoice(int value, Settings s1)
Description copied from interface:EnumSettingsDefinition
Returns the String for the given enum value- Specified by:
getDisplayChoice
in interfaceEnumSettingsDefinition
- Parameters:
value
- the value to get a display string fors1
- the instance settings which may affect the results- Returns:
- the display string for the given settings.
-
clear
public void clear(Settings settings)
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.
-
copySetting
public void copySetting(Settings settings, Settings destSettings)
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:
settings
- the settings to be copieddestSettings
- the settings to be updated.
-
hasValue
public boolean hasValue(Settings setting)
- Specified by:
hasValue
in interfaceSettingsDefinition
-
getDisplayChoice
public java.lang.String getDisplayChoice(Settings settings)
-
setDisplayChoice
public void setDisplayChoice(Settings settings, java.lang.String choice)
Sets the settings object to the enum value indicating the specified choice as a string.- Parameters:
settings
- the settings to store the value.choice
- enum string representing a choice in the enum.
-
-