org.zaproxy.zap.view

Class ScanPanel2<GS extends GenericScanner2,SC extends ScanController<GS>>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.parosproxy.paros.extension.AbstractPanel

org.zaproxy.zap.view.ScanPanel2<GS,SC>

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

ActiveScanPanel, SpiderPanel

public abstract class ScanPanel2<GS extends GenericScanner2,SC extends ScanController<GS>>
extends AbstractPanel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ScanPanel2.Location

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
ScanPanel2(String prefix, ImageIcon icon, SC controller) Constructs a ScanPanel2 with the given message resources prefix, tab icon and scan controller.
ScanPanel2(String prefix, ImageIcon icon, SC controller, AbstractParam scanParam) Deprecated. (2.6.0) Use ScanPanel2(String, ImageIcon, ScanController) instead.

Method Summary

Modifier and Type	Method and Description
protected int	addToolBarElements(JToolBar toolBar, ScanPanel2.Location location, int gridX) Adds elements to the tool bar.
void	clearFinishedScans()
protected SC	getController()
protected GridBagConstraints	getGBC(int gridx, int gridy)
protected GridBagConstraints	getGBC(int gridx, int gridy, double weightx, Insets insets)
protected abstract JButton	getNewScanButton()
protected abstract int	getNumberOfScansToShow()
protected JToggleButton	getPauseScanButton()
protected JProgressBar	getProgressBar()
protected JComboBox<org.zaproxy.zap.view.ScanPanel2.ScanEntry<GS>>	getProgressSelect()
GS	getSelectedScanner()
protected JButton	getStopScanButton()
protected abstract Component	getWorkPanel()
protected boolean	hasOptionsButton() Tells whether or not the tool bar should have a button to open the Options dialogue.
void	reset()
void	scanFinshed(int id, String host)
void	scannerStarted(GS scanner)
void	scanProgress(int id, String host, int progress, int maximum)
void	sessionModeChanged(Control.Mode mode)
void	sessionScopeChanged(Session session)
protected abstract void	switchView(GS scanner)
void	trimProgressList()
protected void	unload()
void	updateScannerUI()

Methods inherited from class org.parosproxy.paros.extension.AbstractPanel

getDefaultAccelerator, getIcon, getMnemonic, getTabIndex, isHideable, isLocked, isPinned, isShowByDefault, isTabVisible, setDefaultAccelerator, setHideable, setIcon, setLocked, setMnemonic, setParent, setPinned, setShowByDefault, setTabFocus, setTabIndex, tabSelected

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanPanel2

@Deprecated
public ScanPanel2(String prefix,
                              ImageIcon icon,
                              SC controller,
                              AbstractParam scanParam)

Deprecated. (2.6.0) Use ScanPanel2(String, ImageIcon, ScanController) instead.

Constructs a ScanPanel2 with the given message resources prefix, tab icon and scan controller.

Parameters:

prefix - the prefix for the resource messages

icon - the icon for the tab of the panel

controller - the scan controller

scanParam - unused

ScanPanel2

public ScanPanel2(String prefix,
                  ImageIcon icon,
                  SC controller)

Constructs a ScanPanel2 with the given message resources prefix, tab icon and scan controller.

Parameters:

prefix - the prefix for the resource messages

icon - the icon for the tab of the panel

controller - the scan controller

Since:

2.6.0

Method Detail

getGBC

protected GridBagConstraints getGBC(int gridx,
                                    int gridy)

getGBC

protected GridBagConstraints getGBC(int gridx,
                                    int gridy,
                                    double weightx,
                                    Insets insets)

hasOptionsButton

protected boolean hasOptionsButton()

Tells whether or not the tool bar should have a button to open the Options dialogue.

Returns true by default.

Returns:

true if the panel's tool bar should have an options button, false otherwise.

Since:

2.8.0

See Also:

addToolBarElements(JToolBar, Location, int)

addToolBarElements

protected int addToolBarElements(JToolBar toolBar,
                                 ScanPanel2.Location location,
                                 int gridX)

Adds elements to the tool bar. The method is called while initializing the ScanPanel, at the points specified by the ScanPanel2.Location enumeration. Should be overridden by all subclasses that want to add new elements to the ScanPanel's tool bar.

The tool bar uses a GridBagLayout, so elements have to be added with a GridBagConstraints. For this, the getGBC methods can be used. The gridX parameter specifies the cell (as used in GridBagConstraints.gridx) of the current row where the elements can be added.

The method must return the new coordinates of the current cell, after the elements have been added.

Note: A button is added at the end of the tool bar to show the Options dialogue, unless hasOptionsButton() returns false. The name of the options panel to show is obtained from the resource message with the key prefix + ".options.title".

Parameters:

toolBar - the tool bar

location - the current location where elements will be added

gridX - the x coordinates of the current cell in the GridBagLayout

Returns:

the new coordinates of the current cell, after the elements have been added.

See Also:

getGBC(int, int), getGBC(int, int, double, Insets), GridBagConstraints, GridBagLayout

getProgressBar

protected JProgressBar getProgressBar()

getStopScanButton

protected JButton getStopScanButton()

getPauseScanButton

protected JToggleButton getPauseScanButton()

clearFinishedScans

public void clearFinishedScans()

getSelectedScanner

public GS getSelectedScanner()

getProgressSelect

protected JComboBox<org.zaproxy.zap.view.ScanPanel2.ScanEntry<GS>> getProgressSelect()

updateScannerUI

public void updateScannerUI()

scanFinshed

public void scanFinshed(int id,
                        String host)

scanProgress

public void scanProgress(int id,
                         String host,
                         int progress,
                         int maximum)

scannerStarted

public void scannerStarted(GS scanner)

trimProgressList

public void trimProgressList()

reset

public void reset()

sessionScopeChanged

public void sessionScopeChanged(Session session)

sessionModeChanged

public void sessionModeChanged(Control.Mode mode)

unload

protected void unload()

getController

protected SC getController()

getWorkPanel

protected abstract Component getWorkPanel()

switchView

protected abstract void switchView(GS scanner)

getNewScanButton

protected abstract JButton getNewScanButton()

getNumberOfScansToShow

protected abstract int getNumberOfScansToShow()