diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/ListingPanel.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/ListingPanel.java index 3b3706d5db..9bb31eb45f 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/ListingPanel.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/ListingPanel.java @@ -155,7 +155,10 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc return preferredSize; } - /** A width for new windows that shows a reasonable amount of the Listing */ + /** + * A width for new windows that shows a reasonable amount of the Listing + * @return the width + */ protected int getNewWindowDefaultWidth() { return 500; } @@ -215,11 +218,12 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc listingModel = newModel; layoutModel = createLayoutModel(newModel); fieldPanel.setLayoutModel(layoutModel); - SwingUtilities.invokeLater(() -> updateProviders()); + Swing.runLater(() -> updateProviders()); } /** * Returns the current ListingModel used by this panel. + * @return the model */ public ListingModel getListingModel() { return listingModel; @@ -255,6 +259,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc /** * Returns true if the field header component is showing. + * @return true if showing */ public boolean isHeaderShowing() { return headerPanel != null; @@ -471,6 +476,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc /** * Returns the FieldPanel used by this ListingPanel. + * @return the field panel */ public FieldPanel getFieldPanel() { return fieldPanel; @@ -502,6 +508,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc /** * Returns the divider location between the left margin areas and the main display. + * @return the location */ public int getDividerLocation() { if (splitPane != null) { @@ -562,6 +569,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc * location in the screen. * * @param loc the location to move to. + * @return true if successful */ public boolean goTo(ProgramLocation loc) { return goTo(loc, true); @@ -576,6 +584,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc * the screen. In that case, when this parameter is true, then the given location * will be placed in the center of the screen; when the parameter is false, then the * screen will be scrolled only enough to show the cursor. + * @return true if succussful */ public boolean goTo(ProgramLocation loc, boolean centerWhenNotVisible) { @@ -598,13 +607,19 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc return true; } - /** Scroll the view of the listing to the given location. */ + /** + * Scroll the view of the listing to the given location. + * @param location the location + */ public void scrollTo(ProgramLocation location) { FieldLocation fieldLocation = getFieldLocation(location); fieldPanel.scrollTo(fieldLocation); } - /** Center the view of the listing around the given location. */ + /** + * Center the view of the listing around the given location. + * @param location the location + */ public void center(ProgramLocation location) { FieldLocation fieldLocation = getFieldLocation(location); fieldPanel.center(fieldLocation); @@ -718,6 +733,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc * Positions the ListingPanel to the given address. * * @param addr the address at which to position the listing. + * @return true if successful */ public boolean goTo(Address addr) { Program p = getProgram(); @@ -817,6 +833,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc /** * Gets the view of this listing panel (meant to be used in conjunction with * {@link #setView(AddressSetView)}. + * @return the addresses */ public AddressSetView getView() { AddressIndexMap map = layoutModel.getAddressIndexMap(); @@ -845,6 +862,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc /** * Sets the background color for the listing panel. This will set the background for the main * listing display. + * @param c the color */ public void setTextBackgroundColor(Color c) { if (fieldPanel != null) { @@ -861,6 +879,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc /** * Returns true if this component has focus. + * @return true if this component has focus. */ public boolean isActive() { return fieldPanel.isFocused(); @@ -868,6 +887,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc /** * Returns the current program location of the cursor. + * @return the location */ public ProgramLocation getProgramLocation() { FieldLocation loc = fieldPanel.getCursorLocation(); @@ -880,7 +900,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc /** * Get a program location for the given point. - * + * @param point the point * @return program location, or null if point does not correspond to a program location */ public ProgramLocation getProgramLocation(Point point) { @@ -888,13 +908,14 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc ListingField field = (ListingField) fieldPanel.getFieldAt(point.x, point.y, dropLoc); if (field != null) { return field.getFieldFactory() - .getProgramLocation(dropLoc.getRow(), dropLoc.getCol(), field); + .getProgramLocation(dropLoc.getRow(), dropLoc.getCol(), field); } return null; } /** * Get the margin providers in this ListingPanel. + * @return the providers */ public List getMarginProviders() { return marginProviders; @@ -902,6 +923,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc /** * Get the overview providers in this ListingPanel. + * @return the providers */ public List getOverviewProviders() { return overviewProviders; @@ -909,6 +931,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc /** * Returns true if the mouse is at a location that can be dragged. + * @return true if the mouse is at a location that can be dragged. */ public boolean isStartDragOk() { return fieldPanel.isStartDragOK(); @@ -958,6 +981,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc /** * Returns the AddressIndexMap currently used by this listing panel. + * @return the map */ public AddressIndexMap getAddressIndexMap() { return layoutModel.getAddressIndexMap(); @@ -965,6 +989,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc /** * Returns the vertical scrollbar used by this panel. + * @return the scroll bar */ public JScrollBar getVerticalScrollBar() { return scroller.getVerticalScrollBar(); @@ -972,6 +997,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc /** * Returns the FormatManager used by this listing panel. + * @return the format manager */ public FormatManager getFormatManager() { return formatManager; @@ -1012,6 +1038,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc /** * Returns the current program selection. + * @return the selection */ public ProgramSelection getProgramSelection() { return layoutModel.getProgramSelection(fieldPanel.getSelection()); @@ -1032,6 +1059,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc /** * Sets the selection to the complement of the current selection in the listing view. + * @return the addresses */ public AddressSet selectComplement() { fieldPanel.requestFocus(); @@ -1111,7 +1139,7 @@ public class ListingPanel extends JPanel implements FieldMouseListener, FieldLoc @Override public void selectionChanged(FieldSelection selection, EventTrigger trigger) { if (listingModel == null) { - // SCR 7092 - Dragging in a popup window that contains a listing while that window + // Dragging in a popup window that contains a listing while that window // closes can trigger this condition return; } diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/MarginProvider.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/MarginProvider.java index f60dad64eb..c7c9522680 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/MarginProvider.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/MarginProvider.java @@ -28,11 +28,13 @@ public interface MarginProvider { /** * Get the component to show the margin markers. + * @return the component */ JComponent getComponent(); /** - * Return whether the component can be resized. + * Return true if can be resized. + * @return true if can be resized. */ boolean isResizeable(); @@ -51,6 +53,7 @@ public interface MarginProvider { * * @param x the horizontal coordinate. * @param y the vertical coordinate. + * @return the location */ public MarkerLocation getMarkerLocation(int x, int y); diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/OverviewProvider.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/OverviewProvider.java index e00b6fd137..be3abd49ff 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/OverviewProvider.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/OverviewProvider.java @@ -27,7 +27,8 @@ import ghidra.program.model.listing.Program; */ public interface OverviewProvider { /** - * Returns the component to diplay in the right margin of the listing. + * Returns the component to display in the right margin of the listing. + * @return the component */ JComponent getComponent(); diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/VerticalPixelAddressMap.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/VerticalPixelAddressMap.java index 251b49da14..bf1db1cd14 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/VerticalPixelAddressMap.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/VerticalPixelAddressMap.java @@ -22,16 +22,19 @@ public interface VerticalPixelAddressMap { /** * Returns the Address of the first layout in this map + * @return the address */ public Address getStartAddress(); /** * Returns the index of the last layout in this map. + * @return the address */ public Address getEndAddress(); /** * Returns the number of layouts in this map. + * @return the number of layouts */ public int getNumLayouts(); @@ -45,12 +48,14 @@ public interface VerticalPixelAddressMap { /** * Returns the y position of the top of the i'th layout. * @param i the index of the layout. + * @return the position */ public int getBeginPosition(int i); /** * Returns the y position of the bottom of the i'th layout. * @param i the index of the layout. + * @return the position */ public int getEndPosition(int i); @@ -71,6 +76,7 @@ public interface VerticalPixelAddressMap { /** * Finds the layout containing the given point. * @param y the y coordinate of layout to be found. + * @return the layout index */ public int findLayoutAt(int y); diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/FieldPanel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/FieldPanel.java index 5659bf6751..61e9d52271 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/FieldPanel.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/FieldPanel.java @@ -45,7 +45,7 @@ import generic.theme.GThemeDefaults.Colors.Messages; import ghidra.util.*; public class FieldPanel extends JPanel - implements IndexedScrollable, LayoutModelListener, ChangeListener, Accessible { + implements IndexedScrollable, LayoutModelListener, ChangeListener { public static final int MOUSEWHEEL_LINES_TO_SCROLL = 3; private LayoutModel model; @@ -335,7 +335,7 @@ public class FieldPanel extends JPanel /** * Returns true if the given field location is rendered on the screen; false if scrolled * offscreen - * + * @param location the location * @return true if the location is on the screen */ public boolean isLocationVisible(FieldLocation location) { @@ -1305,7 +1305,7 @@ public class FieldPanel extends JPanel /** * Finds the layout containing the given y position. - * + * @param y the y location * @return the layout. */ AnchoredLayout findLayoutAt(int y) { @@ -1320,10 +1320,10 @@ public class FieldPanel extends JPanel /** * Notifies all FieldMouselisteners that the cursor position changed. */ - private void notifyFieldMouseListeners(final MouseEvent ev) { - final FieldLocation loc = new FieldLocation(cursorPosition); - final Field field = cursorHandler.getCurrentField(); - SystemUtilities.runSwingLater(() -> { + private void notifyFieldMouseListeners(MouseEvent ev) { + FieldLocation loc = new FieldLocation(cursorPosition); + Field field = cursorHandler.getCurrentField(); + Swing.runLater(() -> { for (FieldMouseListener l : fieldMouseListeners) { l.buttonPressed(loc, field, ev); }