Package ghidra.docking.settings

Class FormatSettingsDefinition

java.lang.Object

ghidra.docking.settings.FormatSettingsDefinition

All Implemented Interfaces:

EnumSettingsDefinition, SettingsDefinition

public class FormatSettingsDefinition
extends java.lang.Object
implements EnumSettingsDefinition

The settings definition for the numeric display format

Field Summary

Fields

Modifier and Type	Field	Description
static int	BINARY
static int	CHAR
static int	DECIMAL
static FormatSettingsDefinition	DEF
static FormatSettingsDefinition	DEF_CHAR
static FormatSettingsDefinition	DEF_DECIMAL
static FormatSettingsDefinition	DEF_HEX
protected static java.lang.String	FORMAT
static int	HEX
static int	OCTAL

Method Summary

Modifier and Type	Method	Description
void	clear(Settings settings)	Removes any values in the given settings object assocated with this settings definition
void	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 settings
java.lang.String	getDescription()	Returns a description of this settings definition
java.lang.String	getDisplayChoice(int value, Settings s1)	Returns the String for the given enum value
java.lang.String	getDisplayChoice(Settings settings)
java.lang.String[]	getDisplayChoices(Settings settings)	Gets the list of choices as strings based on the current settings
int	getFormat(Settings settings)	Returns the format based on the specified settings
java.lang.String	getName()	Returns the name of this SettingsDefinition
int	getRadix(Settings settings)	Returns the numeric radix associated with the format identified by the specified settings.
boolean	hasValue(Settings setting)
void	setChoice(Settings settings, int value)	Sets the given value into the settings object using this definition as a key
void	setDisplayChoice(Settings settings, java.lang.String choice)	Sets the settings object to the enum value indicating the specified choice as a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HEX

public static final int HEX

See Also:

Constant Field Values

DECIMAL

public static final int DECIMAL

See Also:

Constant Field Values

BINARY

public static final int BINARY

See Also:

Constant Field Values

OCTAL

public static final int OCTAL

See Also:

Constant Field Values

CHAR

public static final int CHAR

See Also:

Constant Field Values

FORMAT

protected static final java.lang.String FORMAT

See Also:

Constant Field Values

DEF_CHAR

public static final FormatSettingsDefinition DEF_CHAR

DEF_HEX

public static final FormatSettingsDefinition DEF_HEX

DEF_DECIMAL

public static final FormatSettingsDefinition DEF_DECIMAL

DEF

public static final FormatSettingsDefinition DEF

Method Detail

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)

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

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

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 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 interface EnumSettingsDefinition

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 interface SettingsDefinition

getDescription

public java.lang.String getDescription()

Description copied from interface: SettingsDefinition

Returns a description of this settings definition

Specified by:

getDescription in interface SettingsDefinition

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 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)

Specified by:

hasValue in interface SettingsDefinition

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.