Package ghidra.docking.settings

Class FormatSettingsDefinition

java.lang.Object
ghidra.docking.settings.FormatSettingsDefinition
All Implemented Interfaces:
EnumSettingsDefinition, SettingsDefinition
public class FormatSettingsDefinition extends Object implements EnumSettingsDefinition
The settings definition for the numeric display format

  • Field Details

  • Method Details

    • getFormat

      public int getFormat(Settings settings)
      Returns the format based on the specified settings
      Parameters:
      settings - the instance settings or null for default value.
      Returns:
      the format value (HEX, DECIMAL, BINARY, OCTAL, CHAR), or HEX if invalid data in the FORMAT settings value

    • getRadix

      public int getRadix(Settings settings)
      Returns the numeric radix associated with the format identified by the specified settings.
      Parameters:
      settings - the instance settings.
      Returns:
      the format radix

    • getRepresentationPostfix

      public String getRepresentationPostfix(Settings settings)
      Returns a descriptive string suffix that should be appended after converting a value using the radix returned by getRadix(Settings).
      Parameters:
      settings - the instance settings
      Returns:
      string suffix, such as "h" for HEX, "o" for octal

    • getChoice

      public int getChoice(Settings settings)
      Description copied from interface: EnumSettingsDefinition
      Returns the current value for this settings
      Specified by:
      getChoice in interface EnumSettingsDefinition
      Parameters:
      settings - The settings to search
      Returns:
      the value for the settingsDefintions

    • getValueString

      public String getValueString(Settings settings)
      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 interface SettingsDefinition
      Parameters:
      settings - settings
      Returns:
      value string or null if not set and default has not specified by this definition

    • 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 interface EnumSettingsDefinition
      Parameters:
      settings - the settings to store the value.
      value - the settings value to be stored.

    • getDisplayChoices

      public 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 interface EnumSettingsDefinition
      Parameters:
      settings - the instance settings
      Returns:
      an array of strings which represent valid choices based on the current settings.

    • getName

      public String getName()
      Description copied from interface: SettingsDefinition
      Returns the display name of this SettingsDefinition
      Specified by:
      getName in interface SettingsDefinition
      Returns:
      display name for setting

    • getStorageKey

      public String getStorageKey()
      Description copied from interface: SettingsDefinition
      Get the Settings key which is used when storing a key/value entry.
      Specified by:
      getStorageKey in interface SettingsDefinition
      Returns:
      settings storage key

    • getDescription

      public String getDescription()
      Description copied from interface: SettingsDefinition
      Returns a description of this settings definition
      Specified by:
      getDescription in interface SettingsDefinition
      Returns:
      setting description

    • getDisplayChoice

      public String getDisplayChoice(int value, Settings s1)
      Description copied from interface: EnumSettingsDefinition
      Returns the String for the given enum value
      Specified by:
      getDisplayChoice in interface EnumSettingsDefinition
      Parameters:
      value - the value to get a display string for
      s1 - 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 interface SettingsDefinition
      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 interface SettingsDefinition
      Parameters:
      settings - the settings to be copied
      destSettings - the settings to be updated.

    • hasValue

      public boolean hasValue(Settings setting)
      Description copied from interface: SettingsDefinition
      Determine if a setting value has been stored
      Specified by:
      hasValue in interface SettingsDefinition
      Parameters:
      setting - stored settings
      Returns:
      true if a value has been stored, else false

    • getDisplayChoice

      public String getDisplayChoice(Settings settings)

    • setDisplayChoice

      public void setDisplayChoice(Settings settings, 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.