Package ghidra.features.base.values

Class ProjectFolderValue

java.lang.Object

docking.widgets.values.AbstractValue<DomainFolder>

ghidra.features.base.values.ProjectFolderValue

public class ProjectFolderValue
extends AbstractValue<DomainFolder>

Value class for project folders (DomainFile). The editor component consists of the JTextField and a browse button for bringing up a DataTreeDialog for picking project folders from the current project.

This class and other subclasses of AbstractValue are part of a subsystem for easily defining a set of values that can be displayed in an input dialog (ValuesMapDialog). Typically, these values are created indirectly using a GValuesMap which is then given to the constructor of the dialog. However, an alternate approach is to create the dialog without a ValuesMap and then use its ValuesMapDialog.addValue(AbstractValue) method directly.

Constructor Summary

Constructors

Constructor	Description
ProjectFolderValue(String name)	Constructor for ProjectFolderValues with the given name.
ProjectFolderValue(String name, Project project, String defaultValuePath)	Constructor for creating ProjectFolderValues for projects other than the active project.
ProjectFolderValue(String name, String defaultValuePath)	Constructor for creating a new ProjectFolderValue with the given name and a path for a default folder value.

Method Summary

Modifier and Type	Method	Description
protected DomainFolder	fromString(String valueString)	Parses the given string into a value of type T
JComponent	getComponent()	Returns a JComponent for entering or editing a value of this type.
protected String	toString(DomainFolder v)
protected void	updateComponentFromValue()	Updates the JComponent returned from AbstractValue.getComponent() to represent the current value of this object.
protected void	updateValueFromComponent()	Causes the stored value for this object to be updated based on the state of the JComponent returned from AbstractValue.getComponent()

Methods inherited from class docking.widgets.values.AbstractValue

copyValue, getAsText, getName, getValue, hasValue, reset, setAsText, setValue

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectFolderValue

public ProjectFolderValue(String name)

Constructor for ProjectFolderValues with the given name.

Parameters:

name - the name of the value

ProjectFolderValue

public ProjectFolderValue(String name,
 String defaultValuePath)

Constructor for creating a new ProjectFolderValue with the given name and a path for a default folder value.

Parameters:

name - the name of the value

defaultValuePath - the path for a default folder value

ProjectFolderValue

public ProjectFolderValue(String name,
 Project project,
 String defaultValuePath)

Constructor for creating ProjectFolderValues for projects other than the active project.

Parameters:

name - the name of the value

project - the project to find a folder from

defaultValuePath - the path of a default folder value

Method Details

getComponent

public JComponent getComponent()

Description copied from class: AbstractValue

Returns a JComponent for entering or editing a value of this type.

Specified by:

getComponent in class AbstractValue<DomainFolder>

Returns:

a JComponent for entering or editing a value of this type.

updateValueFromComponent

protected void updateValueFromComponent()
                                 throws ValuesMapParseException

Description copied from class: AbstractValue

Causes the stored value for this object to be updated based on the state of the JComponent returned from AbstractValue.getComponent()

Specified by:

updateValueFromComponent in class AbstractValue<DomainFolder>

Throws:

ValuesMapParseException - if an error occurs trying update the value from a component. This usually is a result of trying to parse a string value.

updateComponentFromValue

protected void updateComponentFromValue()

Description copied from class: AbstractValue

Updates the JComponent returned from AbstractValue.getComponent() to represent the current value of this object.

Specified by:

updateComponentFromValue in class AbstractValue<DomainFolder>

fromString

protected DomainFolder fromString(String valueString)

Description copied from class: AbstractValue

Parses the given string into a value of type T

Specified by:

fromString in class AbstractValue<DomainFolder>

Parameters:

valueString - the string to parse

Returns:

a value of type T

toString

protected String toString(DomainFolder v)

Overrides:

toString in class AbstractValue<DomainFolder>