Package ghidra.framework.main
Class FrontEndTool
- java.lang.Object
-
- docking.AbstractDockingTool
-
- ghidra.framework.plugintool.PluginTool
-
- ghidra.framework.main.FrontEndTool
-
- All Implemented Interfaces:
Tool
,OptionsChangeListener
,ServiceProvider
- Direct Known Subclasses:
TestFrontEndTool
public class FrontEndTool extends PluginTool implements OptionsChangeListener
Tool that serves as the the Ghidra Project Window. Only those plugins that implement the FrontEndable interface may be directly added to this tool by the user. Other plugins that are not marked as FrontEndable may get pulled in because the FrontEndable plugins depend on them. These plugins are aware of what tool they live in so that they can behave in the appropriate manner.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
AUTOMATICALLY_SAVE_TOOLS
-
Fields inherited from class ghidra.framework.plugintool.PluginTool
DESCRIPTION_PROPERTY_NAME, extensionTableProvider, ICON_PROPERTY_NAME, iconURL, isDisposed, manageDialog, PLUGIN_COUNT_PROPERTY_NAME, TOOL_NAME_PROPERTY, toolName
-
Fields inherited from class docking.AbstractDockingTool
configChangedFlag, optionsMap, toolActions, winMgr
-
-
Constructor Summary
Constructors Constructor Description FrontEndTool(ProjectManager pm)
Construct a new Ghidra Project Window.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addProjectListener(ProjectListener l)
Add the given project listener.boolean
canCloseDomainFile(DomainFile df)
void
checkIn(PluginTool tool, DomainFile domainFile)
Check in the given domain file.void
checkIn(PluginTool tool, java.util.List<DomainFile> fileList, java.awt.Component parent)
Check in the list of domain files.void
close()
Close this tool: if there are no tasks running.void
exit()
PluginClassManager
getPluginClassManager()
ToolTemplate
getToolTemplate(boolean includeConfigState)
void
merge(PluginTool tool, DomainFile domainFile, TaskListener taskListener)
Merge the latest version in the repository with the given checked out domain file.void
merge(PluginTool tool, java.util.List<DomainFile> fileList, TaskListener taskListener)
Merge the latest version (in the repository) of each checked out file in fileList.void
optionsChanged(ToolOptions options, java.lang.String optionName, java.lang.Object oldValue, java.lang.Object newValue)
Notification that an option changed.void
removeProjectListener(ProjectListener l)
Remove the given project listener.void
selectFiles(java.util.Set<DomainFile> files)
void
setActiveProject(Project project)
Set the active project.void
setBusy(boolean busy)
void
setVisible(boolean visibility)
Sets the tool visible or invisible.-
Methods inherited from class ghidra.framework.plugintool.PluginTool
acceptDomainFiles, addEventListener, addExitAction, addExportToolAction, addHelpActions, addListenerForAllPluginEvents, addOptionsAction, addPlugin, addPlugin, addPlugins, addPropertyChangeListener, addSaveToolAction, addServiceListener, addStatusComponent, addToolListener, beep, cancelCurrentTask, canClose, canCloseDomainObject, clearLastEvents, contextChanged, createDockingWindowManager, dispose, doSaveTool, execute, execute, execute, executeBackgroundCommand, firePluginEvent, getActiveComponentProvider, getActiveWindow, getConsumedToolEventNames, getDefaultToolContext, getDomainFiles, getIcon, getIconURL, getInstanceName, getLocation, getManagedPlugins, getManagePluginsDialog, getName, getOptions, getOptions, getProject, getProjectManager, getService, getServices, getSize, getSupportedDataTypes, getToolEventNames, getToolName, getToolServices, getTransientState, getUndoRedoToolState, hasOptions, hasToolListeners, hasUnsavedData, initActions, installHomeButton, isConfigurable, isExecutingCommand, isService, isWindowsOnTop, optionsChanged, prepareToSave, processToolEvent, putInstanceName, refreshKeybindings, registerOptionsNameChange, removeEventListener, removeListenerForAllPluginEvents, removePlugins, removePreferenceState, removePropertyChangeListener, removeServiceListener, removeStatusComponent, removeToolListener, restoreDataStateFromXml, restoreFromXml, restoreOptionsFromXml, restorePluginsFromXml, restoreWindowingDataFromXml, saveDataStateToXml, saveTool, saveToolAs, saveToolToToolTemplate, saveToXml, saveWindowingDataToXml, scheduleFollowOnCommand, setConfigChanged, setDefaultComponent, setIconURL, setLocation, setProject, setSize, setSubTitle, setToolName, setUnconfigurable, setWindowsOnTop, shouldSave, showComponentHeader, showConfig, showDialog, showDialog, showDialogOnActiveWindow, showEditWindow, showExtensions, terminateBackgroundCommands, threadIsBackgroundTaskThread
-
Methods inherited from class docking.AbstractDockingTool
addAction, addComponentProvider, addContextListener, addLocalAction, addPopupActionProvider, clearStatusInfo, getAllActions, getComponentProvider, getDockingActionsByOwnerName, getProviderWindow, getToolActions, getToolFrame, getWindowManager, hasConfigChanged, isActive, isVisible, isVisible, removeAction, removeComponentProvider, removeContextListener, removeLocalAction, removePopupActionProvider, setMenuGroup, setMenuGroup, setStatusInfo, setStatusInfo, showComponentProvider, showDialog, toFront, toFront, updateTitle
-
-
-
-
Field Detail
-
AUTOMATICALLY_SAVE_TOOLS
public static final java.lang.String AUTOMATICALLY_SAVE_TOOLS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
FrontEndTool
public FrontEndTool(ProjectManager pm)
Construct a new Ghidra Project Window.- Parameters:
pm
- project manager
-
-
Method Detail
-
getPluginClassManager
public PluginClassManager getPluginClassManager()
- Specified by:
getPluginClassManager
in classPluginTool
-
selectFiles
public void selectFiles(java.util.Set<DomainFile> files)
-
optionsChanged
public void optionsChanged(ToolOptions options, java.lang.String optionName, java.lang.Object oldValue, java.lang.Object newValue)
Description copied from interface:OptionsChangeListener
Notification that an option changed.Note: to reject an options change, you can throw a
OptionsVetoException
.- Specified by:
optionsChanged
in interfaceOptionsChangeListener
- Parameters:
options
- options object containing the property that changedoptionName
- name of option that changedoldValue
- old value of the optionnewValue
- new value of the option
-
exit
public void exit()
- Overrides:
exit
in classPluginTool
-
close
public void close()
Description copied from class:PluginTool
Close this tool:- if there are no tasks running.
- resolve the state of any plugins so they can be closed.
- Prompt the user to save any changes.
- close all associated plugins (this closes the domain object if one is open).
- pop up dialog to save the configuration if it has changed.
- notify the project tool services that this tool is going away.
- Specified by:
close
in interfaceTool
- Overrides:
close
in classPluginTool
-
setActiveProject
public void setActiveProject(Project project)
Set the active project.- Parameters:
project
- may be null if there is no active project
-
addProjectListener
public void addProjectListener(ProjectListener l)
Add the given project listener.- Parameters:
l
- listener to add
-
removeProjectListener
public void removeProjectListener(ProjectListener l)
Remove the given project listener.- Parameters:
l
- listener to remove
-
checkIn
public void checkIn(PluginTool tool, DomainFile domainFile)
Check in the given domain file.- Parameters:
tool
- tool that has the domain file openeddomainFile
- domain file to check in
-
checkIn
public void checkIn(PluginTool tool, java.util.List<DomainFile> fileList, java.awt.Component parent)
Check in the list of domain files.- Parameters:
tool
- tool that has the domain files openedfileList
- list of DomainFile objectsparent
- parent of dialog if an error occurs during checkin
-
merge
public void merge(PluginTool tool, DomainFile domainFile, TaskListener taskListener)
Merge the latest version in the repository with the given checked out domain file. Upon completion of the merge, the domain file appears as though the latest version was checked out.- Parameters:
tool
- tool that has the domain file openeddomainFile
- domain file where latest version will be merged intotaskListener
- listener that is notified when the merge task completes
-
merge
public void merge(PluginTool tool, java.util.List<DomainFile> fileList, TaskListener taskListener)
Merge the latest version (in the repository) of each checked out file in fileList. Upon completion of the merge, the domain file appears as though the latest version was checked out.- Parameters:
tool
- tool that has the domain files openedfileList
- list of files that are checked out and are to be mergedtaskListener
- listener that is notified when the merge task completes
-
setVisible
public void setVisible(boolean visibility)
Description copied from interface:Tool
Sets the tool visible or invisible. This method is used by the Project to make it's tools visible or invisible depending on whether this tool is in is the active workspace.- Specified by:
setVisible
in interfaceTool
- Overrides:
setVisible
in classAbstractDockingTool
- Parameters:
visibility
- true specifies that the tool should be visible
-
setBusy
public void setBusy(boolean busy)
-
getToolTemplate
public ToolTemplate getToolTemplate(boolean includeConfigState)
- Overrides:
getToolTemplate
in classPluginTool
-
canCloseDomainFile
public boolean canCloseDomainFile(DomainFile df)
- Overrides:
canCloseDomainFile
in classPluginTool
-
-