mirror of
https://github.com/NationalSecurityAgency/ghidra.git
synced 2025-10-05 10:49:34 +02:00
Merge branch 'GT-3362_ryanmkurtz_PR-1337_astrelsky_DocumentationFixes'
This commit is contained in:
Ryan Kurtz
commit
b79aaca9d5
136 changed files with 436 additions and 445 deletions
|
|
@ -28,7 +28,7 @@ import docking.action.DockingActionIf;
|
|||
* <b>toolbar buttons and menu items will enable and disable as the user interacts with the system.
|
||||
* Further, popup menu items will not be added to popup menus when they report false for
|
||||
* {@link DockingActionIf#isAddToPopup(ActionContext)}; they will appear in the popup, but be
|
||||
* disabled if they report <tt>true</tt> for the above call, but <tt>false</tt> for
|
||||
* disabled if they report <code>true</code> for the above call, but <code>false</code> for
|
||||
* {@link DockingActionIf#isEnabledForContext(ActionContext)}.</b>
|
||||
* When the user executes an action, the current context will be passed to the backing
|
||||
* {@link DockingActionIf}. Ultimately, context serves to control action enablement and to
|
||||
|
|
|
|||
|
|
@ -175,7 +175,7 @@ public abstract class ComponentProvider implements HelpDescriptor, ActionContext
|
|||
public abstract JComponent getComponent();
|
||||
|
||||
/**
|
||||
* A method that allows children to set the <tt>instanceID</tt> to a desired value (useful for
|
||||
* A method that allows children to set the <code>instanceID</code> to a desired value (useful for
|
||||
* restoring saved IDs).
|
||||
* <p>
|
||||
* Note: this can be called only once during the lifetime of the calling instance; otherwise, an
|
||||
|
|
|
|||
|
|
@ -1002,7 +1002,7 @@ public class DialogComponentProvider
|
|||
|
||||
/**
|
||||
* Sets the button to make "Default" when the dialog is shown. If no default button is
|
||||
* desired, then pass <tt>null</tt> as the <tt>button</tt> value.
|
||||
* desired, then pass <code>null</code> as the <code>button</code> value.
|
||||
* @param button the button to make default enabled.
|
||||
*/
|
||||
public void setDefaultButton(JButton button) {
|
||||
|
|
|
|||
|
|
@ -148,7 +148,7 @@ public class DockingUtils {
|
|||
|
||||
/**
|
||||
* Checks if the mouseEvent has the "control" key down. On windows, this is actually
|
||||
* the <tt>control</tt> key. On Mac, it is the <tt>command</tt> key.
|
||||
* the <code>control</code> key. On Mac, it is the <code>command</code> key.
|
||||
*
|
||||
* @param mouseEvent the event to check
|
||||
* @return true if the control key is pressed
|
||||
|
|
@ -161,7 +161,7 @@ public class DockingUtils {
|
|||
|
||||
/**
|
||||
* Checks if the mouseEvent has the "control" key down. On windows, this is actually
|
||||
* the <tt>control</tt> key. On Mac, it is the <tt>command</tt> key.
|
||||
* the <code>control</code> key. On Mac, it is the <code>command</code> key.
|
||||
*
|
||||
* @param keyEvent the event to check
|
||||
* @return true if the control key is pressed
|
||||
|
|
@ -307,16 +307,16 @@ public class DockingUtils {
|
|||
* <p>
|
||||
* <u>Notes</u>
|
||||
* Historically, to make a component transparent you would call
|
||||
* {@link JComponent#setOpaque(boolean)} with a <tt>false</tt> value. However, it turns out
|
||||
* that the definition and the implementation of this method are at odds. <tt>setOpaque(false)</tt>
|
||||
* {@link JComponent#setOpaque(boolean)} with a <code>false</code> value. However, it turns out
|
||||
* that the definition and the implementation of this method are at odds. <code>setOpaque(false)</code>
|
||||
* is meant to signal that some part of the component is transparent, so the parent component
|
||||
* needs to be painted. Most LaFs implemented this by not painting the background of the
|
||||
* component, but used the parent's color instead. The Nimbus LaF actually honors the
|
||||
* contract of <tt>setOpaque()</tt>, which has the effect of painting the components
|
||||
* contract of <code>setOpaque()</code>, which has the effect of painting the components
|
||||
* background by default.
|
||||
* <p>
|
||||
* This method allows components to achieve transparency when they used to
|
||||
* rely on <tt>setOpaque(false)</tt>.
|
||||
* rely on <code>setOpaque(false)</code>.
|
||||
*
|
||||
* @param c the component to be made transparent
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -219,11 +219,11 @@ public class DockingWindowManager implements PropertyChangeListener, Placeholder
|
|||
}
|
||||
|
||||
/**
|
||||
* A convenience method for getting the window for <tt>component</tt> and then calling
|
||||
* A convenience method for getting the window for <code>component</code> and then calling
|
||||
* {@link #getInstanceForWindow(Window)}.
|
||||
* @param component The component for which to get the associated {@link DockingWindowManager}
|
||||
* instance.
|
||||
* @return The {@link DockingWindowManager} instance associated with <tt>component</tt>
|
||||
* @return The {@link DockingWindowManager} instance associated with <code>component</code>
|
||||
*/
|
||||
public static synchronized DockingWindowManager getInstance(Component component) {
|
||||
Window window = WindowUtilities.windowForComponent(component);
|
||||
|
|
@ -726,7 +726,7 @@ public class DockingWindowManager implements PropertyChangeListener, Placeholder
|
|||
* Hides or shows the component associated with the given provider.
|
||||
* <p><br>
|
||||
* <b>Note: </b> This method will not show the given provider if it has not previously been
|
||||
* added via <tt>addComponent(...)</tt>.
|
||||
* added via <code>addComponent(...)</code>.
|
||||
*
|
||||
* @param provider the provider of the component to be hidden or shown.
|
||||
* @param visibleState true to show the component, false to hide it.
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ import ghidra.util.exception.AssertException;
|
|||
* processing. See {@link #dispatchKeyEvent(KeyEvent)} for a more detailed explanation of how
|
||||
* Ghidra processes key events.
|
||||
* <p>
|
||||
* {@link #install()} must be called in order to install this <tt>Singleton</tt> into Java's
|
||||
* {@link #install()} must be called in order to install this <code>Singleton</code> into Java's
|
||||
* key event processing system.
|
||||
*/
|
||||
public class KeyBindingOverrideKeyEventDispatcher implements KeyEventDispatcher {
|
||||
|
|
@ -98,9 +98,9 @@ public class KeyBindingOverrideKeyEventDispatcher implements KeyEventDispatcher
|
|||
* There are some exceptions to this processing chain:
|
||||
* <ol>
|
||||
* <li>We don't do any processing when the focused component is an instance of
|
||||
* <tt>JTextComponent</tt>.</li>
|
||||
* <code>JTextComponent</code>.</li>
|
||||
* <li>We don't do any processing if the active window is an instance of
|
||||
* <tt>DockingDialog</tt>.</li>
|
||||
* <code>DockingDialog</code>.</li>
|
||||
* </ol>
|
||||
*
|
||||
* @see java.awt.KeyEventDispatcher#dispatchKeyEvent(java.awt.event.KeyEvent)
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
/* ###
|
||||
* IP: GHIDRA
|
||||
* REVIEWED: YES
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
|
|
@ -19,7 +18,7 @@ package docking;
|
|||
/**
|
||||
* An enum that holds the values for order of keybinding precedence, in order from
|
||||
* highest priority to lowest. For a more detailed description of how Ghidra processes
|
||||
* key events see <tt>ghidra.KeyBindingOverrideKeyDispatcher.dispatchKeyEvent(KeyEvent)</tt>
|
||||
* key events see <code>ghidra.KeyBindingOverrideKeyDispatcher.dispatchKeyEvent(KeyEvent)</code>
|
||||
*/
|
||||
public enum KeyBindingPrecedence {
|
||||
|
||||
|
|
|
|||
|
|
@ -75,7 +75,7 @@ public class KeyBindingData {
|
|||
|
||||
/**
|
||||
* Updates the given data with system-independent versions of key modifiers. For example,
|
||||
* the <tt>control</tt> key will be converted to the <tt>command</tt> key on the Mac.
|
||||
* the <code>control</code> key will be converted to the <code>command</code> key on the Mac.
|
||||
* @param newKeyBindingData the data to validate
|
||||
* @return the potentially changed data
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -573,7 +573,7 @@ public class KeyBindingUtils {
|
|||
|
||||
/**
|
||||
* Updates the given data with system-independent versions of key modifiers. For example,
|
||||
* the <tt>control</tt> key will be converted to the <tt>command</tt> key on the Mac.
|
||||
* the <code>control</code> key will be converted to the <code>command</code> key on the Mac.
|
||||
*
|
||||
* @param keyStroke the keystroke to validate
|
||||
* @return the potentially changed keystroke
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
/* ###
|
||||
* IP: GHIDRA
|
||||
* REVIEWED: YES
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
|
|
@ -25,7 +24,7 @@ import java.awt.event.InputEvent;
|
|||
/**
|
||||
* This class receives notification when the user intitiates a
|
||||
* drag and drop operation; it is responsible for getting the
|
||||
* <tt>Transferable</tt> and telling the <TT>DragSource</TT> to
|
||||
* <code>Transferable</code> and telling the <code>DragSource</code> to
|
||||
* start the drag.
|
||||
*/
|
||||
public class DragGestureAdapter implements DragGestureListener {
|
||||
|
|
@ -44,11 +43,11 @@ public class DragGestureAdapter implements DragGestureListener {
|
|||
}
|
||||
|
||||
/**
|
||||
* A <tt>DragGestureRecognizer</tt> has detected a
|
||||
* A <code>DragGestureRecognizer</code> has detected a
|
||||
* platform-dependent Drag and Drop action initiating gesture
|
||||
* and is notifying this Listener in order for it to initiate
|
||||
* the action for the user.
|
||||
* <p>The <tt>DragGestureRecognizer</tt> hides the platform-specific
|
||||
* <p>The <code>DragGestureRecognizer</code> hides the platform-specific
|
||||
* events that initate a drag and drop operation.
|
||||
*
|
||||
* @param e event describing the gesture that has just occurred
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
/* ###
|
||||
* IP: GHIDRA
|
||||
* REVIEWED: YES
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
|
|
@ -23,7 +22,7 @@ import java.awt.dnd.*;
|
|||
* Adapter class that receives notifications in order to
|
||||
* provide drag over effects.
|
||||
* <p> When the operation ends, this class receives a
|
||||
* <tt>dragDropEnd</tt> message, and is responsible for
|
||||
* <code>dragDropEnd</code> message, and is responsible for
|
||||
* checking the success of the operation. If the operation was
|
||||
* successful, and if it was a Move, then
|
||||
* this class will remove the source data.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
/* ###
|
||||
* IP: GHIDRA
|
||||
* REVIEWED: YES
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
|
|
@ -26,7 +25,7 @@ import java.util.ArrayList;
|
|||
/**
|
||||
* Class to handle notifications of drag and drop operations that occur
|
||||
* on the DropTarget object. The DropTarget is the component that accepts
|
||||
* drops during a drag and drop operation. The <tt>drop</tt>
|
||||
* drops during a drag and drop operation. The <code>drop</code>
|
||||
* method actually transfers the data.
|
||||
*/
|
||||
public class DropTgtAdapter implements DropTargetListener {
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ public interface HelpService {
|
|||
/**
|
||||
* Register help for a specific object.
|
||||
*
|
||||
* <P>Do not call this method will a <tt>null</tt> help location. Instead, to signal that
|
||||
* <P>Do not call this method will a <code>null</code> help location. Instead, to signal that
|
||||
* an item has no help, call {@link #excludeFromHelp(Object)}.
|
||||
*
|
||||
* @param helpObject the object to associate the specified help location with
|
||||
|
|
|
|||
|
|
@ -21,9 +21,9 @@ import ghidra.util.HelpLocation;
|
|||
import ghidra.util.SystemUtilities;
|
||||
|
||||
/**
|
||||
* Note: this class overrides the <tt>equals(Object)</tt> and relies upon the <tt>equals</tt>
|
||||
* method of the <tt>userData</tt> object. Thus, if it is important that equals work for you in
|
||||
* the non-standard identity way, then you must override <tt>equals</tt> in your user data objects.
|
||||
* Note: this class overrides the <code>equals(Object)</code> and relies upon the <code>equals</code>
|
||||
* method of the <code>userData</code> object. Thus, if it is important that equals work for you in
|
||||
* the non-standard identity way, then you must override <code>equals</code> in your user data objects.
|
||||
*
|
||||
* @param <T> the type of the action state
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ import docking.util.GraphicsUtils;
|
|||
* <pre>
|
||||
* [Checkbox][Icon][Menu Item Content][Menu Pull-right/Accelerator Text]
|
||||
* </pre>
|
||||
* To display the <b>Menu Item Content</b> in a tabular fashion, use the <tt>'\t'</tt> character
|
||||
* To display the <b>Menu Item Content</b> in a tabular fashion, use the <code>'\t'</code> character
|
||||
* to delimit the data into columns. This class will align all menu items in the given menu
|
||||
* based upon the largest number of columns in the group and the largest width for each column.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ public class MenuGroupMap {
|
|||
* Sets the group for the given menuPath
|
||||
* @param menuPath the menuPath for which to assign a group
|
||||
* @param group the name of the group for the action with the given menu path
|
||||
* @param menuSubGroup the name used for sorting items in the same <tt>group</tt>. If this
|
||||
* @param menuSubGroup the name used for sorting items in the same <code>group</code>. If this
|
||||
* value is {@link MenuData#NO_SUBGROUP}, then sorting is based upon the name of the
|
||||
* menu item.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -75,8 +75,8 @@ public abstract class MultiActionDockingAction extends DockingAction
|
|||
}
|
||||
|
||||
/**
|
||||
* By default a click on this action will trigger <tt>actionPerformed()</tt> to be called.
|
||||
* You can call this method to disable that feature. When called with <tt>false</tt>, this
|
||||
* By default a click on this action will trigger <code>actionPerformed()</code> to be called.
|
||||
* You can call this method to disable that feature. When called with <code>false</code>, this
|
||||
* method will effectively let the user click anywhere on the button or its drop-down arrow
|
||||
* to show the popup menu. During normal operation, the user can only show the popup by
|
||||
* clicking the drop-down arrow.
|
||||
|
|
|
|||
|
|
@ -99,9 +99,9 @@ public abstract class MultiStateDockingAction<T> extends DockingAction {
|
|||
public abstract void actionStateChanged(ActionState<T> newActionState, EventTrigger trigger);
|
||||
|
||||
/**
|
||||
* If <tt>doPerformAction</tt> is <tt>true</tt>, then, when the user clicks the
|
||||
* If <code>doPerformAction</code> is <code>true</code>, then, when the user clicks the
|
||||
* button and not the drop-down arrow, the {@link #doActionPerformed(ActionContext)}
|
||||
* method will be called. If <tt>doPerformAction</tt> is <tt>false</tt>, then, when
|
||||
* method will be called. If <code>doPerformAction</code> is <code>false</code>, then, when
|
||||
* the user clicks the button and not the drop-down arrow, the popup menu will be shown, just
|
||||
* as if the user had clicked the drop-down arrow.
|
||||
* <p>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,8 @@ public class MultipleActionDockingToolbarButton extends EmptyBorderButton {
|
|||
}
|
||||
|
||||
/**
|
||||
* By default a click on this button will trigger <tt>actionPerformed()</tt> to be called.
|
||||
* You can call this method to disable that feature. When called with <tt>false</tt>, this
|
||||
* By default a click on this button will trigger <code>actionPerformed()</code> to be called.
|
||||
* You can call this method to disable that feature. When called with <code>false</code>, this
|
||||
* method will effectively let the user click anywhere on the button or its drop-down arrow
|
||||
* to show the popup menu. During normal operation, the user can only show the popup by
|
||||
* clicking the drop-down arrow.
|
||||
|
|
|
|||
|
|
@ -258,8 +258,8 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
|
|||
}
|
||||
|
||||
/**
|
||||
* Waits for a window with the given name. If <tt>parentWindow</tt> is not null, then it
|
||||
* will be used to find subordinate windows. If <tt>parentWindow</tt> is null, then all
|
||||
* Waits for a window with the given name. If <code>parentWindow</code> is not null, then it
|
||||
* will be used to find subordinate windows. If <code>parentWindow</code> is null, then all
|
||||
* existing frames will be searched.
|
||||
*
|
||||
* @param parentWindow The parent of the window for which to search, or null to search all
|
||||
|
|
@ -364,7 +364,7 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
|
|||
* Check for and display message component text associated with
|
||||
* ErrLogDialog and OptionDialog windows.
|
||||
* @param w any window
|
||||
* @return the message string if one can be found; <tt>null</tt> otherwise
|
||||
* @return the message string if one can be found; <code>null</code> otherwise
|
||||
*/
|
||||
public static String checkMessageDisplay(Window w) {
|
||||
Component c = findComponentByName(w, "MESSAGE-COMPONENT");
|
||||
|
|
@ -634,7 +634,7 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
|
|||
* Waits for the first window of the given class.
|
||||
*
|
||||
* @param ghidraClass The class of the dialog the user desires
|
||||
* @return The first occurrence of a dialog that extends the given <tt>ghirdraClass</tt>
|
||||
* @return The first occurrence of a dialog that extends the given <code>ghirdraClass</code>
|
||||
* @see #waitForDialogComponent(Window, Class, int)
|
||||
*/
|
||||
public static <T extends DialogComponentProvider> T waitForDialogComponent(
|
||||
|
|
@ -644,13 +644,13 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
|
|||
|
||||
/**
|
||||
* Waits for the first window of the given class. This method assumes that the desired dialog
|
||||
* is parented by <tt>parentWindow</tt>.
|
||||
* is parented by <code>parentWindow</code>.
|
||||
*
|
||||
* @param parentWindow The parent of the desired dialog; may be null
|
||||
* @param clazz The class of the dialog the user desires
|
||||
* @param timeoutMS The max amount of time in milliseconds to wait for the requested dialog
|
||||
* to appear.
|
||||
* @return The first occurrence of a dialog that extends the given <tt>ghirdraClass</tt>
|
||||
* @return The first occurrence of a dialog that extends the given <code>ghirdraClass</code>
|
||||
* @deprecated Instead call one of the methods that does not take a timeout
|
||||
* (we are standardizing timeouts). The timeouts passed to this method will
|
||||
* be ignored in favor of the standard value.
|
||||
|
|
@ -748,7 +748,7 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
|
|||
|
||||
/**
|
||||
* Searches for the first occurrence of a {@link ComponentProvider} that is an instance of
|
||||
* the given <tt>providerClass</tt>.
|
||||
* the given <code>providerClass</code>.
|
||||
*
|
||||
* @param clazz The class of the ComponentProvider to locate
|
||||
* @return The component provider, or null if one cannot be found
|
||||
|
|
@ -778,10 +778,10 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
|
|||
|
||||
/**
|
||||
* Searches for the first occurrence of a {@link ComponentProvider} that is an instance of
|
||||
* the given <tt>providerClass</tt>. This method will repeat the search every
|
||||
* the given <code>providerClass</code>. This method will repeat the search every
|
||||
* {@link #DEFAULT_WAIT_DELAY} milliseconds
|
||||
* until the provider is found, or the maximum number of searches has been reached, where
|
||||
* <tt>maximum number of searches = MaxTimeMS / {@link #DEFAULT_WAIT_DELAY} </tt>
|
||||
* <code>maximum number of searches = MaxTimeMS / {@link #DEFAULT_WAIT_DELAY} </code>
|
||||
*
|
||||
* @param clazz The class of the ComponentProvider to locate
|
||||
* @return The component provider, or null if one cannot be found
|
||||
|
|
@ -867,9 +867,9 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
|
|||
* <p>
|
||||
* Note: this method assumes the given node is not a RootNode, but a child thereof
|
||||
*
|
||||
* @param node The <tt>Node</tt> instance that contains the desired <tt>ComponentProvider</tt>
|
||||
* @param node The <code>Node</code> instance that contains the desired <code>ComponentProvider</code>
|
||||
* or other nodes.
|
||||
* @param providerClass The <tt>ComponentProvider</tt> class for which to search.
|
||||
* @param providerClass The <code>ComponentProvider</code> class for which to search.
|
||||
*/
|
||||
private static ComponentProvider getComponentProviderFromNode(Object node,
|
||||
Class<? extends ComponentProvider> providerClass) {
|
||||
|
|
@ -906,10 +906,10 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
|
|||
|
||||
/**
|
||||
* Searches for the first occurrence of a {@link ComponentProvider} that is an instance of
|
||||
* the given <tt>providerClass</tt>. This method will repeat the search every
|
||||
* the given <code>providerClass</code>. This method will repeat the search every
|
||||
* {@link #DEFAULT_WAIT_DELAY} milliseconds
|
||||
* until the provider is found, or the maximum number of searches has been reached, where
|
||||
* <tt>maximum number of searches = MaxTimeMS / {@link #DEFAULT_WAIT_DELAY} </tt>
|
||||
* <code>maximum number of searches = MaxTimeMS / {@link #DEFAULT_WAIT_DELAY} </code>
|
||||
*
|
||||
* @param parentWindow The window that will become the parent window of the provider (this is
|
||||
* typically the tool's frame).
|
||||
|
|
@ -1012,7 +1012,7 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
|
|||
|
||||
/**
|
||||
* Finds the toggle button with the given name inside of the given container and then
|
||||
* ensures that the selected state of the button matches <tt>selected</tt>.
|
||||
* ensures that the selected state of the button matches <code>selected</code>.
|
||||
* <p>
|
||||
* Note: this works for any instanceof {@link JToggleButton}, such as:
|
||||
* <ul>
|
||||
|
|
@ -1049,7 +1049,7 @@ public abstract class AbstractDockingTest extends AbstractGenericTest {
|
|||
}
|
||||
|
||||
/**
|
||||
* Ensures that the selected state of the button matches <tt>selected</tt>.
|
||||
* Ensures that the selected state of the button matches <code>selected</code>.
|
||||
* <p>
|
||||
* Note: this works for most toggle button implementations which are derived from
|
||||
* AbstractButton and relay on {@link AbstractButton#isSelected()} and
|
||||
|
|
|
|||
|
|
@ -25,9 +25,9 @@ import javax.swing.ListSelectionModel;
|
|||
*
|
||||
* <P><b>Usage note:</b> Typically this text field will not be used directly, but will
|
||||
* instead be used indirectly by way of an editor.
|
||||
* If this field is used directly, then the user should use {@link #setSelectedValue(Object)} and
|
||||
* {@link #getSelectedValue()} to get and set data on this field, rather than calling
|
||||
* <strike>{@link #setText(String)}</strike> and <strike>{@link #getText()}</strike>.
|
||||
* If this field is used directly, then the user should use <ins>{@link #setSelectedValue(Object)}</ins> and
|
||||
* <ins>{@link #getSelectedValue()}</ins> to get and set data on this field, rather than calling
|
||||
* <del>{@link #setText(String)}</del> and <del>{@link #getText()}</del>.
|
||||
*
|
||||
* <P>Usage notes:
|
||||
* <UL>
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ import javax.swing.ListCellRenderer;
|
|||
public interface DropDownTextFieldDataModel<T> {
|
||||
|
||||
/**
|
||||
* Returns a list of data that matches the given <tt>searchText</tt>. A match typically
|
||||
* Returns a list of data that matches the given <code>searchText</code>. A match typically
|
||||
* means a "startsWith" match. A list is returned to allow for multiple matches.
|
||||
*
|
||||
* @param searchText The text used to find matches.
|
||||
|
|
|
|||
|
|
@ -89,8 +89,8 @@ public class HyperlinkComponent extends JPanel {
|
|||
/**
|
||||
* Add a listener that will be called whenever hyperlink updates happen (hover, activate, etc).
|
||||
*
|
||||
* @param anchorName The value in the <tt>href</tt> attribute of the anchor tag.
|
||||
* @param listener The listener to be called when the anchor(s) with a matching <tt>href</tt> is
|
||||
* @param anchorName The value in the <code>href</code> attribute of the anchor tag.
|
||||
* @param listener The listener to be called when the anchor(s) with a matching <code>href</code> is
|
||||
* manipulated by the user.
|
||||
*/
|
||||
public void addHyperlinkListener(String anchorName, HyperlinkListener listener) {
|
||||
|
|
|
|||
|
|
@ -41,10 +41,10 @@ import ghidra.util.exception.AssertException;
|
|||
* The primary type of
|
||||
* dialog provided herein is the basic option dialog that allows the user to specify the buttons
|
||||
* that appear on the dialog. By default, the given option text will appear as a button(s),
|
||||
* followed by a <tt>Cancel</tt> button (you can call the
|
||||
* followed by a <code>Cancel</code> button (you can call the
|
||||
* {@link #showOptionNoCancelDialog(Component, String, String, String, String, int)} methods if
|
||||
* you do not want a <tt>Cancel</tt> button. To use this type of dialog you can use the
|
||||
* various <b><tt>showOptionDialog*</tt></b> methods.
|
||||
* you do not want a <code>Cancel</code> button. To use this type of dialog you can use the
|
||||
* various <b><code>showOptionDialog*</code></b> methods.
|
||||
* </p>
|
||||
* <p>
|
||||
* Each of the option dialog methods will return a result, which is a number indicating the
|
||||
|
|
@ -70,8 +70,8 @@ import ghidra.util.exception.AssertException;
|
|||
* <h3>Yes/No Dialogs</h3><br>
|
||||
* <blockquote>
|
||||
* <p>
|
||||
* Finally, there are a series of methods that present <tt>Yes</tt> and <tt>No</tt> buttons in
|
||||
* a dialog. There are versions that do and do not have a <tt>Cancel</tt> button.
|
||||
* Finally, there are a series of methods that present <code>Yes</code> and <code>No</code> buttons in
|
||||
* a dialog. There are versions that do and do not have a <code>Cancel</code> button.
|
||||
* </p>
|
||||
* </blockquote>
|
||||
*
|
||||
|
|
@ -789,8 +789,8 @@ public class OptionDialog extends DialogComponentProvider {
|
|||
/**
|
||||
* Dialog with only YES/NO options, <b>no CANCEL</b>
|
||||
* <p>
|
||||
* The dialog shown by this method will have the <tt>No</tt> button set as the default button so
|
||||
* that an Enter key press will trigger a <tt>No</tt> action.
|
||||
* The dialog shown by this method will have the <code>No</code> button set as the default button so
|
||||
* that an Enter key press will trigger a <code>No</code> action.
|
||||
*
|
||||
* @param parent The parent component of this dialog. If the given component is
|
||||
* a frame or dialog, then the component will be used to parent the option dialog.
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ import ghidra.util.Swing;
|
|||
* is different than adding an option named "Cancel" which would return a result greater than
|
||||
* <code>0</code>, depending on where in the order it was added.
|
||||
*
|
||||
* <P><a name="RememberOption"></a>A "Remember Option" can be added to OptionDialog to
|
||||
* <P><a id="RememberOption"></a>A "Remember Option" can be added to OptionDialog to
|
||||
* present the user with a choice for remembering a dialog result and automatically
|
||||
* returning that result instead of showing the dialog or similar dialogs in the future.
|
||||
* Note that for simple OK dialogs, there really isn't a meaningful result to remember, other
|
||||
|
|
|
|||
|
|
@ -163,7 +163,7 @@ public class GhidraComboBox<E> extends JComboBox<E> implements GComponent {
|
|||
* By default Ghidra disables the forwarding altogether, since most users of
|
||||
* {@link GhidraComboBox} will add an action listener to handle <Enter> actions.
|
||||
* <p>
|
||||
* To re-enable the default behavior, set the <tt>forwardEnter</tt> value to true.
|
||||
* To re-enable the default behavior, set the <code>forwardEnter</code> value to true.
|
||||
*
|
||||
* @param forwardEnter true to enable default <Enter> key handling.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ public class InputWithChoicesDialog extends DialogComponentProvider {
|
|||
* can check the value of {@link #isCanceled()} to know whether or not
|
||||
* the user canceled the operation. To get the user selected value use the
|
||||
* {@link #getValue()} value(s) entered by the user. If the user cancelled the operation, then
|
||||
* null will be returned from <tt>getValue()</tt>.
|
||||
* null will be returned from <code>getValue()</code>.
|
||||
* <P>
|
||||
*
|
||||
* @param dialogTitle used as the name of the dialog's title bar
|
||||
|
|
@ -70,7 +70,7 @@ public class InputWithChoicesDialog extends DialogComponentProvider {
|
|||
* can check the value of {@link #isCanceled()} to know whether or not
|
||||
* the user canceled the operation. To get the user selected value use the
|
||||
* {@link #getValue()} value(s) entered by the user. If the user cancelled the operation, then
|
||||
* null will be returned from <tt>getValue()</tt>.
|
||||
* null will be returned from <code>getValue()</code>.
|
||||
* <P>
|
||||
*
|
||||
* @param dialogTitle used as the name of the dialog's title bar
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
/* ###
|
||||
* IP: GHIDRA
|
||||
* REVIEWED: YES
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
|
|
@ -39,7 +38,7 @@ public interface FieldElement {
|
|||
|
||||
/**
|
||||
* Returns the length of the text within this element. This is a convenience method for
|
||||
* calling <tt>getText().length()</tt>.
|
||||
* calling <code>getText().length()</code>.
|
||||
* @return the length of the text within this element.
|
||||
*/
|
||||
public int length();
|
||||
|
|
|
|||
|
|
@ -26,8 +26,8 @@ import org.jdom.Element;
|
|||
* end row (exclusive).
|
||||
* <p>
|
||||
* Conceptually, this class can be thought of as a range of rows (defined by
|
||||
* <tt>startIndex</tt> and <tt>endindex</tt>) with sub-positions within those rows (defined by
|
||||
* <tt>startField</tt> and <tt>endField</tt>). As an example, consider a text select that begins on
|
||||
* <code>startIndex</code> and <code>endindex</code>) with sub-positions within those rows (defined by
|
||||
* <code>startField</code> and <code>endField</code>). As an example, consider a text select that begins on
|
||||
* some word in a row and ends on another word in a different row.
|
||||
*/
|
||||
public class FieldRange implements Comparable<FieldRange> {
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ public class FilterTextField extends JPanel {
|
|||
private WeakSet<Callback> enterListeners = WeakDataStructureFactory.createCopyOnWriteWeakSet();
|
||||
|
||||
/**
|
||||
* Constructs this text field with the given component. <tt>component</tt> may be null, but
|
||||
* Constructs this text field with the given component. <code>component</code> may be null, but
|
||||
* then this field will be unable to flash in response to focus events (see the header
|
||||
* documentation).
|
||||
*
|
||||
|
|
@ -75,7 +75,7 @@ public class FilterTextField extends JPanel {
|
|||
|
||||
/**
|
||||
* Constructs this text field with the given component and the preferred visible column
|
||||
* width. <tt>component</tt> may be null, but then this field will be able to flash in
|
||||
* width. <code>component</code> may be null, but then this field will be able to flash in
|
||||
* response to focus events (see the header documentation).
|
||||
* @param component The component needed to listen for focus changes, may be null.
|
||||
* @param columns The number of preferred visible columns (see JTextField)
|
||||
|
|
@ -164,15 +164,15 @@ public class FilterTextField extends JPanel {
|
|||
* <p>
|
||||
* Note: this method will not perform the alert if the minimum time between alerts
|
||||
* has not passed. To force the alter to take place, call {@link #alert(boolean)} with a
|
||||
* value of <tt>true</tt>.
|
||||
* value of <code>true</code>.
|
||||
*/
|
||||
public void alert() {
|
||||
alert(false);
|
||||
}
|
||||
|
||||
/**
|
||||
* This is the same as {@link #alert()} with the exception that a <tt>true</tt> value for
|
||||
* <tt>forceAlter</tt> will guarantee that the alert will happen. A <tt>false</tt> value
|
||||
* This is the same as {@link #alert()} with the exception that a <code>true</code> value for
|
||||
* <code>forceAlter</code> will guarantee that the alert will happen. A <code>false</code> value
|
||||
* will not perform the alert if the minimum time between alerts has not passed.
|
||||
* @param forceAlert true signals to force the alter to take place.
|
||||
* @see #alert()
|
||||
|
|
|
|||
|
|
@ -270,7 +270,7 @@ public abstract class AbstractSortedTableModel<T> extends AbstractGTableModel<T>
|
|||
/**
|
||||
* A default sort method that uses the {@link Collections#sort(List, Comparator)} method for
|
||||
* sorting. Implementors with reasonably sized data sets can rely on this method. For data
|
||||
* sets that can become large, the <tt>ThreadedTableModel</tt> is the recommended base class,
|
||||
* sets that can become large, the <code>ThreadedTableModel</code> is the recommended base class,
|
||||
* as it handles loading/sorting/filtering in a threaded way.
|
||||
*
|
||||
* @param data The data to be sorted
|
||||
|
|
@ -303,7 +303,7 @@ public abstract class AbstractSortedTableModel<T> extends AbstractGTableModel<T>
|
|||
|
||||
/**
|
||||
* Fires an event to let the listeners (like JTable) know that things have been changed.
|
||||
* This method exists so that subclasses have a way to call the various <tt>tableChanged()</tt>
|
||||
* This method exists so that subclasses have a way to call the various <code>tableChanged()</code>
|
||||
* methods without triggering this class's overridden version.
|
||||
* @param dataChanged True signals that the actual data has changed; false signals that the
|
||||
* data is the same, with exception that attributes of that data may be different.
|
||||
|
|
|
|||
|
|
@ -81,23 +81,23 @@ public class DiscoverableTableUtils {
|
|||
/**
|
||||
* Returns all "discovered" {@link AbstractDynamicTableColumn} classes that are compatible with the
|
||||
* given class, which represents the object for a table's row. For example, many tables use
|
||||
* <tt>Address</tt> as the row type. In this case, passing <tt>Address.class</tt> as the
|
||||
* <code>Address</code> as the row type. In this case, passing <code>Address.class</code> as the
|
||||
* parameter to this method will return all {@link AbstractDynamicTableColumn}s that can provide column
|
||||
* data by working with <tt>Address</tt> instances.
|
||||
* data by working with <code>Address</code> instances.
|
||||
*
|
||||
* <p><u>Usage Notes:</u> This class will not only discover {@link AbstractDynamicTableColumn}s
|
||||
* that directly support the given class type, but will also use discovered
|
||||
* {@link TableRowMapper} objects to create adapters that allow the
|
||||
* use of table row data that does not exactly match the supported type of discovered
|
||||
* {@link AbstractDynamicTableColumn} classes. For example, suppose that a table's row type is
|
||||
* <tt>Address</tt>. This methods will return at least all {@link AbstractDynamicTableColumn}s
|
||||
* that support <tt>Address</tt> data. In order to support extra columns, Ghidra has
|
||||
* created a {@link TableRowMapper} that can convert a <tt>ProgramLocation</tt> into an
|
||||
* <tt>Address</tt>. This method will find and use this mapper to return a
|
||||
* <code>Address</code>. This methods will return at least all {@link AbstractDynamicTableColumn}s
|
||||
* that support <code>Address</code> data. In order to support extra columns, Ghidra has
|
||||
* created a {@link TableRowMapper} that can convert a <code>ProgramLocation</code> into an
|
||||
* <code>Address</code>. This method will find and use this mapper to return a
|
||||
* {@link MappedTableColumn} instance (which is an {@link AbstractDynamicTableColumn}). By doing
|
||||
* this, any table that has <tt>Address</tt> objects as its row type can now use
|
||||
* {@link AbstractDynamicTableColumn}s that support <tt>ProgramLocations</tt> in addition to
|
||||
* <tt>Address</tt> objects. These mappers provide a way for tables that have non-standard
|
||||
* this, any table that has <code>Address</code> objects as its row type can now use
|
||||
* {@link AbstractDynamicTableColumn}s that support <code>ProgramLocations</code> in addition to
|
||||
* <code>Address</code> objects. These mappers provide a way for tables that have non-standard
|
||||
* Ghidra data as their row type to take advantage of existing dynamic columns for standard
|
||||
* Ghidra data (like ProgramLocations and Addresses).
|
||||
*
|
||||
|
|
@ -129,7 +129,7 @@ public class DiscoverableTableUtils {
|
|||
}
|
||||
|
||||
/**
|
||||
* If the given <tt>DynamicTableColumn</tt> is a match for the given <tt>rowTypeClass</tt>, then
|
||||
* If the given <code>DynamicTableColumn</code> is a match for the given <code>rowTypeClass</code>, then
|
||||
* it will be added to the given list.
|
||||
* <p>
|
||||
* <u>Implementation Notes:</u>
|
||||
|
|
@ -149,7 +149,7 @@ public class DiscoverableTableUtils {
|
|||
* @param rowTypeClass The class of the table's row data (with the same type as
|
||||
* COLUMN_ROW_TYPE)
|
||||
* @param tableColumn The column to add to the given collection if it supports the
|
||||
* given <tt>rowTypeClass</tt>.
|
||||
* given <code>rowTypeClass</code>.
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
// Each cast is checked below (see notes)
|
||||
|
|
@ -192,13 +192,13 @@ public class DiscoverableTableUtils {
|
|||
|
||||
/**
|
||||
* Returns a {@link TableRowMapper} for the given class types if one is found. The
|
||||
* returned mapper will know how to translate instances of <tt>fromType</tt> to
|
||||
* <tt>toType</tt>.
|
||||
* returned mapper will know how to translate instances of <code>fromType</code> to
|
||||
* <code>toType</code>.
|
||||
*
|
||||
* @param <ROW_TYPE> The type of row that is defined by the table
|
||||
* @param <EXPECTED_TYPE> The type of row object that is desired
|
||||
* @param fromType The <tt>Class</tt> object of the given row type
|
||||
* @param toType The <tt>Class</tt> object of the desired row type
|
||||
* @param fromType The <code>Class</code> object of the given row type
|
||||
* @param toType The <code>Class</code> object of the desired row type
|
||||
* @return a new TableRowMapper
|
||||
*/
|
||||
@SuppressWarnings({ "unchecked" }) // we verified before casting
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ import utilities.util.reflection.ReflectionUtilities;
|
|||
* made visible through the UI.
|
||||
* <p>
|
||||
* This model will also discover other system columns that understand how to render
|
||||
* <tt>ROW_TYPE</tt> data directly. Also, if you create a {@link TableRowMapper mapper}(s) for
|
||||
* <code>ROW_TYPE</code> data directly. Also, if you create a {@link TableRowMapper mapper}(s) for
|
||||
* your row type, then this model will load columns for each type for which a mapper was created,
|
||||
* all as optional, hidden columns.
|
||||
* <p>
|
||||
|
|
|
|||
|
|
@ -236,7 +236,7 @@ public class GTable extends JTable {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the {@link SelectionManager} in use by this GTable. <tt>null</tt> is returned
|
||||
* Returns the {@link SelectionManager} in use by this GTable. <code>null</code> is returned
|
||||
* if the user has installed their own {@link ListSelectionModel}.
|
||||
*
|
||||
* @return the selection manager
|
||||
|
|
@ -880,7 +880,7 @@ public class GTable extends JTable {
|
|||
* <ul>
|
||||
* <li>Wrap tooltip text content with an <html> tag so that it is possible for
|
||||
* the content to be formatted in a manner that is easier for the user read, and</li>
|
||||
* <li>Enable any <tt>default</tt> {@link GTableCellRenderer} instances to render
|
||||
* <li>Enable any <code>default</code> {@link GTableCellRenderer} instances to render
|
||||
* HTML content, which they do not do by default.</li>
|
||||
* </ul>
|
||||
* <p>
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ import utility.function.Callback;
|
|||
* <u>Filter Reminder</u><br>
|
||||
* The filter text will flash as the table (by default) gains focus. This is done to remind the
|
||||
* user that the data has been filtered. To change the component that triggers the flashing use
|
||||
* {@link #setFocusComponent(Component)}, where the <tt>Component</tt> parameter is the
|
||||
* {@link #setFocusComponent(Component)}, where the <code>Component</code> parameter is the
|
||||
* component that will trigger focus flashing when it gains focus. To disable focus flashing,
|
||||
* pass in null to {@link #setFocusComponent(Component)}.
|
||||
* <p>
|
||||
|
|
@ -74,7 +74,7 @@ import utility.function.Callback;
|
|||
*
|
||||
* <b><u>Important Usage Notes</u></b>
|
||||
* <ul>
|
||||
* <li><b><a name="translation"></a>You must translate row values retrieved from the table using
|
||||
* <li><b><a id="translation"></a>You must translate row values retrieved from the table using
|
||||
* this panel.</b>
|
||||
* <p>
|
||||
* Since this class wraps the given table with a new model, you must use this class to
|
||||
|
|
@ -82,15 +82,15 @@ import utility.function.Callback;
|
|||
* code snippet below will give the incorrect value:
|
||||
* <pre>
|
||||
* JTable table = ...
|
||||
* <font color="red">int selectedRowNumber = table.getSelectedRow();</font>
|
||||
* <span style="color:red">int selectedRowNumber = table.getSelectedRow();</span>
|
||||
* </pre>
|
||||
* Instead, you must translate the returned value from above, as in the following snippet:
|
||||
* <pre>
|
||||
* JTable table = ...
|
||||
* <font color="green">
|
||||
* <span style="color:green">
|
||||
* int selectedRowNumber = table.getSelectedRow();
|
||||
* int modelRowNumber = tableFilterPanel.getModelRow( selectedRowNumber ); // see {@link #getModelRow(int)}
|
||||
* </font>
|
||||
* </span>
|
||||
* </pre>
|
||||
*
|
||||
* <li><b>This class may set a new model on the given table, which can affect how tables are sized.</b>
|
||||
|
|
@ -904,7 +904,7 @@ public class GTableFilterPanel<ROW_OBJECT> extends JPanel {
|
|||
* multiple instances created in the same place will cause them all to share the same key and
|
||||
* thus to have the same filter settings when they are created initially.
|
||||
* <p>
|
||||
* As an example, consider a plugin that creates <tt>n</tt> providers. If each provider uses
|
||||
* As an example, consider a plugin that creates <code>n</code> providers. If each provider uses
|
||||
* a filter panel, then each provider will share the same filter settings when that provider
|
||||
* is created. If this is not what you want, then you need to override this method to
|
||||
* generate a unique key for each provider.
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ import javax.swing.table.TableColumnModel;
|
|||
|
||||
/**
|
||||
* A GUI that provides a filterable table. You are required to provide the method names
|
||||
* of <TT>T</TT> that should be used to create columns in the table.
|
||||
* of <code>T</code> that should be used to create columns in the table.
|
||||
*
|
||||
* @param <T> the row object type that will be in the table
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ public interface RowObjectFilterModel<ROW_OBJECT> extends RowObjectTableModel<RO
|
|||
* <p>The downside of this is that we cache data for every completed filter. So, in a
|
||||
* degenerate case, with a large dataset, with many incremental filtering steps, where each
|
||||
* did not significantly reduce the previous set of data, the table could then consume
|
||||
* a large amount of memory, roughly equal to <tt>allData.size() * numberOfFilterSteps</tt>
|
||||
* a large amount of memory, roughly equal to <code>allData.size() * numberOfFilterSteps</code>
|
||||
*
|
||||
* <p>Most tables do not have enough data for this to have a significant impact.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ public interface RowObjectTableModel<T> extends TableModel {
|
|||
* <b>Note: the index returned is always the 'view' index. For non-filtering table models,
|
||||
* the 'view' and the 'model' index are the same. However, for filtering table models,
|
||||
* the 'view' may be a subset of the 'model' index. Thus, it is possible, if this model
|
||||
* is a filtering model, that the given <tt>t</tt> may not have a row value for the current
|
||||
* is a filtering model, that the given <code>t</code> may not have a row value for the current
|
||||
* state of the model (i.e., when the model is filtered in the view. If you really need to
|
||||
* get the model index in such a situation, see {@link RowObjectFilterModel}.
|
||||
* </b>
|
||||
|
|
@ -74,7 +74,7 @@ public interface RowObjectTableModel<T> extends TableModel {
|
|||
* filtering, this will be the filtered version of the data. Furthermore, the data should be
|
||||
* the underlying data and not a copy, as this method will potentially sort the given data.
|
||||
* <p>
|
||||
* For those subclasses using an array, you may use the <tt>Arrays</tt> class to create
|
||||
* For those subclasses using an array, you may use the <code>Arrays</code> class to create
|
||||
* a list backed by the array ({@link Arrays#asList(Object...)}).
|
||||
* @return the model data.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ import utilities.util.reflection.ReflectionUtilities;
|
|||
* <p>
|
||||
* This interface is an ExtensionPoint so that once created, they will be ingested automatically
|
||||
* by Ghidra. Once discovered, these mappers will be used to provide dynamic columns to to
|
||||
* tables with row types that match <tt>ROW_TYPE</tt>.
|
||||
* tables with row types that match <code>ROW_TYPE</code>.
|
||||
*
|
||||
* @param <ROW_TYPE> The row type of a given table model
|
||||
* @param <EXPECTED_ROW_TYPE> The row type expected by dynamic columns.
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ public interface VariableColumnTableModel extends TableModel {
|
|||
* Gets the count of the default columns for this model. This model may have non-default
|
||||
* columns added. This method will return the count of columns that have been setup
|
||||
* specifically by the table model. This method can be used to iterate of the first
|
||||
* <tt>n</tt> columns of this model in order to get information for the default columns by
|
||||
* <code>n</code> columns of this model in order to get information for the default columns by
|
||||
* calling methods like {@link #getColumnName(int)}.
|
||||
*
|
||||
* @return Gets the count of the default columns for this model.
|
||||
|
|
|
|||
|
|
@ -85,7 +85,7 @@ public abstract class AbstractColumnConstraintEditor<T> implements ColumnConstra
|
|||
* <p>
|
||||
* Subclasses should override this method if they choose to provide a
|
||||
* detailed constraint editor. This is an optional feature, and this implementation
|
||||
* returns null to satisfy the <tt>ColumnConstraintEditor</tt> contract.
|
||||
* returns null to satisfy the <code>ColumnConstraintEditor</code> contract.
|
||||
*
|
||||
* @see #getDetailComponent()
|
||||
* @return the editors detail component; null in this implementation
|
||||
|
|
|
|||
|
|
@ -73,7 +73,7 @@ public interface ColumnConstraintEditor<T> {
|
|||
|
||||
/**
|
||||
* If the editor contains and invalid value, this message should indicate
|
||||
* why the value is invalid. Only called if <tt>hasValidValue()</tt> returns false.
|
||||
* why the value is invalid. Only called if <code>hasValidValue()</code> returns false.
|
||||
* @return an error message, or an empty string if no error
|
||||
*/
|
||||
public String getErrorMessage();
|
||||
|
|
|
|||
|
|
@ -93,8 +93,8 @@ public class EnumConstraintEditor<T extends Enum<T>> extends AbstractColumnConst
|
|||
* name for a value; this attempts to locate one such function within the Enum class.
|
||||
* <p>
|
||||
* This searches the enum class for a zero-argument, String-returning method called
|
||||
* <tt>getName()</tt>, <tt>getDisplayName()</tt>, or <tt>getDisplayString()</tt>
|
||||
* before falling back to <tt>toString()</tt>.
|
||||
* <code>getName()</code>, <code>getDisplayName()</code>, or <code>getDisplayString()</code>
|
||||
* before falling back to <code>toString()</code>.
|
||||
*
|
||||
* @return a more user-friendly name for the value
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ public class MappedColumnConstraintEditor<T, M> implements ColumnConstraintEdito
|
|||
}
|
||||
|
||||
/**
|
||||
* Sets the <tt>T</tt>-converted-to-<tt>W</tt> type in the delegate editor
|
||||
* Sets the <code>T</code>-converted-to-<code>W</code> type in the delegate editor
|
||||
* <p>
|
||||
* {@inheritDoc}
|
||||
*
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ import docking.widgets.table.TableFilter;
|
|||
|
||||
/**
|
||||
* A table filter that represents the state of having no filter. This allows us to not have to
|
||||
* use <tt>null</tt> to have multiple meanings.
|
||||
* use <code>null</code> to have multiple meanings.
|
||||
*
|
||||
* @param <ROW_OBJECT> the type of the row of the table model using this filter
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ import ghidra.util.task.TaskMonitor;
|
|||
* are no add/removes in the list, then that step does nothing.
|
||||
* <p>
|
||||
* Before the job completes, new calls to sort and filter can be called. If the job is past the
|
||||
* stage of the new call, the <tt>monitor</tt> is cancelled, causing the current stage to abort.
|
||||
* stage of the new call, the <code>monitor</code> is cancelled, causing the current stage to abort.
|
||||
* The next state of this job is set to the appropriate state for the call, the monitor is
|
||||
* reset, and the job begins executing the next stage, based upon the new call.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -74,9 +74,9 @@ public abstract class ThreadedTableModel<ROW_OBJECT, DATA_SOURCE>
|
|||
* This variable can be in one of three states:
|
||||
* <ul>
|
||||
* <li>null - signals that there is no filter change taking place</li>
|
||||
* <li>An instance of <tt>NullTableFitler</tt> - the client has removed the current
|
||||
* <li>An instance of <code>NullTableFitler</code> - the client has removed the current
|
||||
* filter by calling {@link #setTableFilter(TableFilter)} with a null value</li>
|
||||
* <li>An instance of a custom <tt>TableFitler</tt> - the client has changed the
|
||||
* <li>An instance of a custom <code>TableFitler</code> - the client has changed the
|
||||
* filter to a non-null value by calling {@link #setTableFilter(TableFilter)}</li>
|
||||
* </ul>
|
||||
*/
|
||||
|
|
@ -406,7 +406,7 @@ public abstract class ThreadedTableModel<ROW_OBJECT, DATA_SOURCE>
|
|||
|
||||
/**
|
||||
* Override this to change how filtering is performed. This implementation will do nothing
|
||||
* if a <tt>TableFilter</tt> has not been set via a call to {@link #setTableFilter(TableFilter)}.
|
||||
* if a <code>TableFilter</code> has not been set via a call to {@link #setTableFilter(TableFilter)}.
|
||||
*
|
||||
*
|
||||
* @param data The list of data to be filtered.
|
||||
|
|
@ -463,7 +463,7 @@ public abstract class ThreadedTableModel<ROW_OBJECT, DATA_SOURCE>
|
|||
}
|
||||
|
||||
/**
|
||||
* Sets the given <tt>TableFitler</tt> on this model. This table filter will then be used
|
||||
* Sets the given <code>TableFitler</code> on this model. This table filter will then be used
|
||||
* by this model in the default {@link #doFilter(List, TableSortingContext, TaskMonitor)}
|
||||
* method.
|
||||
* @param tableFitler The filter to use for table filtering.
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ import ghidra.util.task.TaskMonitor;
|
|||
* A version of {@link ThreadedTableModel} for clients that do not need a DATA_SOURCE.
|
||||
* <p>
|
||||
* <b>
|
||||
* Note: this class will change a <tt>null</tt> value for the {@link ServiceProvider} parameter
|
||||
* Note: this class will change a <code>null</code> value for the {@link ServiceProvider} parameter
|
||||
* to a stubbed version. If your model needs a real service provider, then you can pass a
|
||||
* non-null value.
|
||||
* </b>
|
||||
|
|
|
|||
|
|
@ -319,7 +319,7 @@ public class GTree extends JPanel implements BusyListener {
|
|||
* state.
|
||||
* <p>
|
||||
* <b>Note: </b>See the usage note at the header of this class concerning how tree state
|
||||
* is used relative to the <tt>equals()</tt> method.
|
||||
* is used relative to the <code>equals()</code> method.
|
||||
* @return the saved state
|
||||
*/
|
||||
public GTreeState getTreeState() {
|
||||
|
|
@ -335,7 +335,7 @@ public class GTree extends JPanel implements BusyListener {
|
|||
* state object.
|
||||
* <p>
|
||||
* <b>Note: </b>See the usage note at the header of this class concerning how tree state
|
||||
* is used relative to the <tt>equals()</tt> method.
|
||||
* is used relative to the <code>equals()</code> method.
|
||||
*
|
||||
* @param state the state to restore
|
||||
*
|
||||
|
|
@ -1025,7 +1025,7 @@ public class GTree extends JPanel implements BusyListener {
|
|||
}
|
||||
|
||||
/**
|
||||
* Passing a value of <tt>false</tt> signals to disable the {@link JTree}'s default behavior
|
||||
* Passing a value of <code>false</code> signals to disable the {@link JTree}'s default behavior
|
||||
* of showing handles for leaf nodes until they are opened.
|
||||
*
|
||||
* @param enable False to disable the default JTree behavior
|
||||
|
|
|
|||
|
|
@ -45,15 +45,15 @@ import util.CollectionUtils;
|
|||
* <li>getIcon()</li>
|
||||
* </ul>
|
||||
*
|
||||
* <a name="usage"></a>Usage Notes:
|
||||
* <a id="usage"></a>Usage Notes:
|
||||
* <ul>
|
||||
* <li>The <b><tt>equals()</tt></b> method: The <tt>GTree</tt> has the ability to remember expanded and
|
||||
* <li>The <b><code>equals()</code></b> method: The <code>GTree</code> has the ability to remember expanded and
|
||||
* selected states. This will only work if the nodes in the saved state can be matched
|
||||
* with the nodes in the <tt>GTree</tt>. Java will do this by using the <tt>equals()</tt> method.
|
||||
* There is a potential problem with this usage. If nodes within the <tt>GTree</tt> get rebuilt (
|
||||
* with the nodes in the <code>GTree</code>. Java will do this by using the <code>equals()</code> method.
|
||||
* There is a potential problem with this usage. If nodes within the <code>GTree</code> get rebuilt (
|
||||
* i.e., new nodes are created), then, by default, the expanded and selected state
|
||||
* feature will be unable to find the correct nodes, since the default <tt>equals()</tt>
|
||||
* method on <tt>GTreeNode</tt> performs a comparison based upon instances. To fix this problem,
|
||||
* feature will be unable to find the correct nodes, since the default <code>equals()</code>
|
||||
* method on <code>GTreeNode</code> performs a comparison based upon instances. To fix this problem,
|
||||
* the {@link #equals(Object)} method has been implemented such that nodes are considered equal if they have
|
||||
* the same name. The {@link #hashCode()} method will return the hash of the name. The name
|
||||
* attribute was chosen because it should be the most unique and descriptive piece of information
|
||||
|
|
|
|||
|
|
@ -73,7 +73,7 @@ public class IntegerSignednessFormattingModeSettingsDefinition implements EnumSe
|
|||
}
|
||||
|
||||
/**
|
||||
* Set, or clear if <tt>mode</tt> is null, the new mode in the provided settings
|
||||
* Set, or clear if <code>mode</code> is null, the new mode in the provided settings
|
||||
* @param settings settings object
|
||||
* @param mode new value to assign, or null to clear
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -112,8 +112,8 @@ public class DockingWindowsLookAndFeelUtils {
|
|||
/**
|
||||
* Set the look and feel (LAF) indicated by the string passed in as a parameter.
|
||||
* The string value can be either the class name of the LAF, as returned by
|
||||
* <tt>LookAndFeelInfo.getClassName()</tt> or the name as returned by
|
||||
* <tt>LookAndFeelInfo.getName()</tt>.
|
||||
* <code>LookAndFeelInfo.getClassName()</code> or the name as returned by
|
||||
* <code>LookAndFeelInfo.getName()</code>.
|
||||
* <p>
|
||||
* Note: to be effective, this call needs to be made before any components have been created
|
||||
* and shown.
|
||||
|
|
|
|||
|
|
@ -141,7 +141,7 @@ public class TaskBuilder {
|
|||
}
|
||||
|
||||
/**
|
||||
* Sets whether this task reports progress. The default is <tt>true</tt>.
|
||||
* Sets whether this task reports progress. The default is <code>true</code>.
|
||||
*
|
||||
* @param hasProgress true if the task reports progress
|
||||
* @return this builder
|
||||
|
|
@ -152,7 +152,7 @@ public class TaskBuilder {
|
|||
}
|
||||
|
||||
/**
|
||||
* Sets whether the task can be cancelled. The default is <tt>true</tt>.
|
||||
* Sets whether the task can be cancelled. The default is <code>true</code>.
|
||||
*
|
||||
* @param canCancel true if the task can be cancelled.
|
||||
* @return this builder
|
||||
|
|
@ -163,7 +163,7 @@ public class TaskBuilder {
|
|||
}
|
||||
|
||||
/**
|
||||
* Sets the component over which the task dialog will be shown. The default is <tt>null</tt>,
|
||||
* Sets the component over which the task dialog will be shown. The default is <code>null</code>,
|
||||
* which shows the dialog over the active window.
|
||||
*
|
||||
* @param parent the parent
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ import ghidra.util.Swing;
|
|||
* {@link #TaskLauncher(Task, Component, int, int)}. Alternatively, for simpler uses,
|
||||
* see one of the many static convenience methods.
|
||||
*
|
||||
* <p><b><a name="modal_usage">Modal Usage</a></b><br>
|
||||
* <p><b><a id="modal_usage">Modal Usage</a></b><br>
|
||||
* Most clients of this class should not be concerned with where
|
||||
* the dialog used by this class will appear. By default, it will be shown over
|
||||
* the active window, which is the desired
|
||||
|
|
|
|||
|
|
@ -267,10 +267,10 @@ public class TaskMonitorComponent extends JPanel implements TaskMonitor {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns true if {@link #setIndeterminate(boolean)} with a value of <tt>true</tt> has
|
||||
* Returns true if {@link #setIndeterminate(boolean)} with a value of <code>true</code> has
|
||||
* been called.
|
||||
*
|
||||
* @return true if {@link #setIndeterminate(boolean)} with a value of <tt>true</tt> has
|
||||
* @return true if {@link #setIndeterminate(boolean)} with a value of <code>true</code> has
|
||||
* been called.
|
||||
*/
|
||||
public boolean isIndeterminate() {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue